@wix/auto_sdk_blog_draft-posts 1.0.31 → 1.0.32

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

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { DraftPost, CreateDraftPostOptions, CreateDraftPostResponse, BulkCreateDraftPostsOptions, BulkCreateDraftPostsResponse, BulkUpdateDraftPostsOptions, BulkUpdateDraftPostsResponse, ListDeletedDraftPostsOptions, ListDeletedDraftPostsResponse, GetDraftPostOptions, GetDraftPostResponse, UpdateDraftPost, UpdateDraftPostOptions, UpdateDraftPostResponse, DeleteDraftPostOptions, BulkDeleteDraftPostsOptions, BulkDeleteDraftPostsResponse, ListDraftPostsOptions, ListDraftPostsResponse, GetDeletedDraftPostResponse, RestoreFromTrashBinResponse, QueryDraftPostsOptions, DraftPostsQueryBuilder, PublishDraftPostResponse, DraftCreatedEnvelope, DraftDeletedEnvelope, DraftUpdatedEnvelope } from './index.typings.js';
 export { Action, ActionEvent, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, ApplicationError, ApproveDraftPostRequest, ApproveDraftPostResponse, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BaseEventMetadata, BlockquoteData, BlogPaging, BookingData, Border, BorderColors, BulkActionMetadata, BulkCreateDraftPostsRequest, BulkDeleteDraftPostsRequest, BulkDraftPostResult, BulkRejectDraftPostRequest, BulkRejectDraftPostResponse, BulkRevertToUnpublishedRequest, BulkRevertToUnpublishedResponse, BulkUpdateDraftPostLanguageRequest, BulkUpdateDraftPostLanguageResponse, BulkUpdateDraftPostsRequest, BulletedListData, ButtonData, ButtonDataType, CaptionData, Category, CategoryTranslation, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, CoverMedia, CoverMediaMediaOneOf, CreateDraftPostRequest, Crop, CursorPaging, Cursors, Decoration, DecorationDataOneOf, DecorationType, DeleteDraftPostRequest, DeleteDraftPostResponse, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, DraftCategoriesUpdated, DraftPostOwnerChanged, DraftPostTranslation, DraftPostsQueryResult, DraftTagsUpdated, EmbedData, EmbedMedia, EmbedThumbnail, EmbedVideo, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventData, EventMetadata, Field, FileData, FileSource, FileSourceDataOneOf, FocalPoint, FontSizeData, FontType, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetDeletedDraftPostRequest, GetDraftPostRequest, GetDraftPostTotalsRequest, GetDraftPostTotalsResponse, GetDraftPostsSort, GetPostAmountsByLanguageRequest, GetPostAmountsByLanguageResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialDraftPostsCopied, InitialExpandedItems, IsDraftPostAutoTranslatableRequest, IsDraftPostAutoTranslatableResponse, Item, ItemDataOneOf, ItemMetadata, ItemStyle, Keyword, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListDeletedDraftPostsRequest, ListDraftPostsRequest, ListValue, MapData, MapSettings, MapType, MarkPostAsInModerationRequest, MarkPostAsInModerationResponse, MaskedDraftPosts, Media, MediaMediaOneOf, MentionData, MessageEnvelope, MetaData, Metadata, ModerationDetails, ModerationStatusStatus, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, Origin, PDFSettings, Paging, PagingMetadataV2, ParagraphData, Permissions, PlatformQuery, PlatformQueryPagingMethodOneOf, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, PostAmountByLanguage, PublishDraftPostRequest, QueryDraftPostsRequest, QueryDraftPostsResponse, RejectDraftPostRequest, RejectDraftPostResponse, Rel, RemoveFromTrashBinRequest, RemoveFromTrashBinResponse, RestoreFromTrashBinRequest, RestoreInfo, RevertToUnpublishedRequest, RevertToUnpublishedResponse, RichContent, SeoSchema, Settings, SortOrder, Sorting, Source, Spoiler, SpoilerData, Status, Styles, StylesBorder, TableCellData, TableData, Tag, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, TotalDraftPosts, TotalDraftPostsGroupingField, TranslateCategoryRequest, TranslateCategoryResponse, TranslateDraftRequest, TranslateDraftResponse, Type, UnpublishPostRequest, UnpublishPostResponse, UpdateDraftPostContentRequest, UpdateDraftPostContentResponse, UpdateDraftPostLanguageRequest, UpdateDraftPostLanguageResponse, UpdateDraftPostRequest, V1Media, VerticalAlignment, Video, VideoData, VideoResolution, ViewMode, ViewRole, VoteRole, WebhookIdentityType, Width, WidthType, WixMedia } from './index.typings.js';
 
+type DraftNonNullablePaths = `_id` | `title` | `categoryIds` | `hashtags` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `status` | `moderationDetails.submittedBy` | `moderationDetails.status` | `hasUnpublishedChanges` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom`;
 declare function createDraftPost$1(httpClient: HttpClient): CreateDraftPostSignature;
 interface CreateDraftPostSignature {
     /**
@@ -17,7 +18,9 @@ interface CreateDraftPostSignature {
      * @param - Draft post to create.
      * @param - Options for creating a draft post.
      */
-    (draftPost: DraftPost, options?: CreateDraftPostOptions | undefined): Promise<CreateDraftPostResponse>;
+    (draftPost: NonNullablePaths<DraftPost, `title`>, options?: CreateDraftPostOptions): Promise<NonNullablePaths<CreateDraftPostResponse, {
+        [P in DraftNonNullablePaths]: `draftPost.${P}`;
+    }[DraftNonNullablePaths]>>;
 }
 declare function bulkCreateDraftPosts$1(httpClient: HttpClient): BulkCreateDraftPostsSignature;
 interface BulkCreateDraftPostsSignature {
@@ -26,7 +29,9 @@ interface BulkCreateDraftPostsSignature {
      * @param - Draft posts to create.
      * @param - Options for creating multiple draft posts.
      */
-    (draftPosts: DraftPost[], options?: BulkCreateDraftPostsOptions | undefined): Promise<BulkCreateDraftPostsResponse>;
+    (draftPosts: NonNullablePaths<DraftPost, `title`>[], options?: BulkCreateDraftPostsOptions): Promise<NonNullablePaths<BulkCreateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
+    }[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkUpdateDraftPosts$1(httpClient: HttpClient): BulkUpdateDraftPostsSignature;
 interface BulkUpdateDraftPostsSignature {
@@ -34,7 +39,9 @@ interface BulkUpdateDraftPostsSignature {
      * Updates multiple draft posts.
      * @param - Options for updating multiple draft posts.
      */
-    (options?: BulkUpdateDraftPostsOptions | undefined): Promise<BulkUpdateDraftPostsResponse>;
+    (options?: NonNullablePaths<BulkUpdateDraftPostsOptions, `draftPosts.${number}.draftPost` | `draftPosts.${number}.draftPost._id`>): Promise<NonNullablePaths<BulkUpdateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
+    }[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function listDeletedDraftPosts$1(httpClient: HttpClient): ListDeletedDraftPostsSignature;
 interface ListDeletedDraftPostsSignature {
@@ -47,7 +54,9 @@ interface ListDeletedDraftPostsSignature {
      * - `paging.offset` is `0`.
      * @param - Options for listing deleted draft posts.
      */
-    (options?: ListDeletedDraftPostsOptions | undefined): Promise<ListDeletedDraftPostsResponse>;
+    (options?: ListDeletedDraftPostsOptions): Promise<NonNullablePaths<ListDeletedDraftPostsResponse, {
+        [P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
+    }[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
 }
 declare function getDraftPost$1(httpClient: HttpClient): GetDraftPostSignature;
 interface GetDraftPostSignature {
@@ -56,7 +65,9 @@ interface GetDraftPostSignature {
      * @param - Draft post ID.
      * @param - Options for getting a draft post.
      */
-    (draftPostId: string, options?: GetDraftPostOptions | undefined): Promise<GetDraftPostResponse>;
+    (draftPostId: string, options?: GetDraftPostOptions): Promise<NonNullablePaths<GetDraftPostResponse, {
+        [P in DraftNonNullablePaths]: `draftPost.${P}`;
+    }[DraftNonNullablePaths]>>;
 }
 declare function updateDraftPost$1(httpClient: HttpClient): UpdateDraftPostSignature;
 interface UpdateDraftPostSignature {
@@ -66,7 +77,9 @@ interface UpdateDraftPostSignature {
      * @param - Options for updating a draft post.
      * @param - Draft Post info.
      */
-    (_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions | undefined): Promise<UpdateDraftPostResponse>;
+    (_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise<NonNullablePaths<UpdateDraftPostResponse, {
+        [P in DraftNonNullablePaths]: `draftPost.${P}`;
+    }[DraftNonNullablePaths]>>;
 }
 declare function deleteDraftPost$1(httpClient: HttpClient): DeleteDraftPostSignature;
 interface DeleteDraftPostSignature {
@@ -78,7 +91,7 @@ interface DeleteDraftPostSignature {
      * @param - Draft post ID.
      * @param - Options for deleting a draft post.
      */
-    (draftPostId: string, options?: DeleteDraftPostOptions | undefined): Promise<void>;
+    (draftPostId: string, options?: DeleteDraftPostOptions): Promise<void>;
 }
 declare function removeFromTrashBin$1(httpClient: HttpClient): RemoveFromTrashBinSignature;
 interface RemoveFromTrashBinSignature {
@@ -97,7 +110,9 @@ interface BulkDeleteDraftPostsSignature {
      * @param - Post IDs.
      * @param - Options for deleting multiple draft posts.
      */
-    (postIds: string[], options?: BulkDeleteDraftPostsOptions | undefined): Promise<BulkDeleteDraftPostsResponse>;
+    (postIds: string[], options?: BulkDeleteDraftPostsOptions): Promise<NonNullablePaths<BulkDeleteDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
+    }[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function listDraftPosts$1(httpClient: HttpClient): ListDraftPostsSignature;
 interface ListDraftPostsSignature {
@@ -110,7 +125,9 @@ interface ListDraftPostsSignature {
      * - `paging.offset` is `0`.
      * @param - Options for listing multiple draft posts.
      */
-    (options?: ListDraftPostsOptions | undefined): Promise<ListDraftPostsResponse>;
+    (options?: ListDraftPostsOptions): Promise<NonNullablePaths<ListDraftPostsResponse, {
+        [P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
+    }[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
 }
 declare function getDeletedDraftPost$1(httpClient: HttpClient): GetDeletedDraftPostSignature;
 interface GetDeletedDraftPostSignature {
@@ -118,7 +135,9 @@ interface GetDeletedDraftPostSignature {
      * Retrieves a deleted draft post from the trash bin by the provided ID.
      * @param - Draft post ID.
      */
-    (draftPostId: string): Promise<GetDeletedDraftPostResponse>;
+    (draftPostId: string): Promise<NonNullablePaths<GetDeletedDraftPostResponse, {
+        [P in DraftNonNullablePaths]: `draftPost.${P}`;
+    }[DraftNonNullablePaths]>>;
 }
 declare function restoreFromTrashBin$1(httpClient: HttpClient): RestoreFromTrashBinSignature;
 interface RestoreFromTrashBinSignature {
@@ -126,7 +145,9 @@ interface RestoreFromTrashBinSignature {
      * Restores a deleted draft post from the trash bin by the provided ID.
      * @param - Draft post ID.
      */
-    (draftPostId: string): Promise<RestoreFromTrashBinResponse>;
+    (draftPostId: string): Promise<NonNullablePaths<RestoreFromTrashBinResponse, {
+        [P in DraftNonNullablePaths]: `draftPost.${P}`;
+    }[DraftNonNullablePaths]>>;
 }
 declare function queryDraftPosts$1(httpClient: HttpClient): QueryDraftPostsSignature;
 interface QueryDraftPostsSignature {
@@ -147,7 +168,7 @@ interface QueryDraftPostsSignature {
      * The following `DraftPostsQueryBuilder` functions are supported for `queryDraftPosts()`. For a full description of the Draft Posts object, see the object returned for the `items` property in `DraftPostsQueryResult`.
      * @param - Options for querying draft posts.
      */
-    (options?: QueryDraftPostsOptions | undefined): DraftPostsQueryBuilder;
+    (options?: QueryDraftPostsOptions): DraftPostsQueryBuilder;
 }
 declare function publishDraftPost$1(httpClient: HttpClient): PublishDraftPostSignature;
 interface PublishDraftPostSignature {
@@ -159,7 +180,7 @@ interface PublishDraftPostSignature {
      * from the draft post.
      * @param - Draft post ID.
      */
-    (draftPostId: string): Promise<PublishDraftPostResponse>;
+    (draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`>>;
 }
 declare const onDraftCreated$1: EventDefinition<DraftCreatedEnvelope, "wix.blog.v3.draft_created">;
 declare const onDraftDeleted$1: EventDefinition<DraftDeletedEnvelope, "wix.blog.v3.draft_deleted">;