@wix/auto_sdk_blog_draft-posts 1.0.90 → 1.0.91

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

@@ -82,6 +82,25 @@ interface DraftPost {
      * @format LANGUAGE_TAG
      */
     language?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     */
+    changeOrigin?: OriginWithLiterals;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    contentId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @format GUID
+     */
+    editingSessionId?: string | null;
     /**
      * Draft Post rich content.
      *
@@ -97,6 +116,13 @@ interface DraftPost {
     status?: StatusWithLiterals;
     /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
     moderationDetails?: ModerationDetails;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @format GUID
+     */
+    mostRecentContributorId?: string | null;
     /**
      * Indicates if there are changes made to the draft post that have not yet been published.
      * @readonly
@@ -112,10 +138,23 @@ interface DraftPost {
      * @readonly
      */
     scheduledPublishDate?: Date | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     */
+    content?: Record<string, any> | null;
     /** Date the post was first published. */
     firstPublishedDate?: Date | null;
     /** SEO data. */
     seoData?: SeoSchema;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 5000
+     * @maxLength 100
+     */
+    slugs?: string[];
     /**
      * Draft post URL preview. What the URL will look like once the post is published.
      * @readonly
@@ -135,6 +174,32 @@ interface DraftPost {
     media?: Media;
     /** Number of paragraphs to display in a paid content preview for non-paying users. */
     previewTextParagraph?: number | null;
+    /**
+     * List of the post's translated posts.
+     * @internal
+     * @readonly
+     * @maxSize 1000
+     */
+    translations?: DraftPostTranslation[];
+    /**
+     * Reserved for internal use, not included in base response.
+     * @internal
+     * @format GUID
+     */
+    originPostId?: string | null;
+    /**
+     * Reserved for internal use, not included in base response.
+     * @internal
+     * @format GUID
+     */
+    originPostInstanceId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    internalId?: string | null;
 }
 interface FocalPoint {
     /** X-coordinate of the focal point. */
@@ -2824,6 +2889,13 @@ declare enum Status {
     SCHEDULED = "SCHEDULED",
     /** Status indicating the draft post is deleted. */
     DELETED = "DELETED",
+    /**
+     * Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.
+     * Target removal date 2024-06-30
+     * Reserved for internal use.
+     * @internal
+     */
+    IN_MODERATION = "IN_MODERATION",
     /** Status indicating the draft post is in review. */
     IN_REVIEW = "IN_REVIEW"
 }
@@ -2948,8 +3020,68 @@ interface VideoResolution {
     height?: number;
     /** Video width. */
     width?: number;
+    /**
+     * Deprecated. Use the `posters` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    poster?: string;
     /** Video format for example, mp4, hls. */
     format?: string;
+    /**
+     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+     * @internal
+     * @deprecated
+     */
+    urlExpirationDate?: Date | null;
+    /**
+     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+     * @internal
+     * @format DECIMAL_VALUE
+     * @deprecated
+     */
+    sizeInBytes?: string | null;
+    /**
+     * Video quality. For example: 480p, 720p.
+     * @internal
+     */
+    quality?: string | null;
+    /**
+     * Video filename.
+     * @internal
+     */
+    filename?: string | null;
+    /**
+     * Video duration in seconds.
+     * @internal
+     * @readonly
+     * @deprecated Video duration in seconds.
+     * @replacedBy duration_in_milliseconds
+     * @targetRemovalDate 2024-08-01
+     */
+    durationInSeconds?: number | null;
+    /**
+     * Video duration in milliseconds.
+     * @internal
+     * @readonly
+     */
+    durationInMilliseconds?: number | null;
+    /**
+     * When true, this is a protected asset, and calling the URL will return a 403 error.
+     * In order to access private assets, make a request to:
+     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+     * @internal
+     * @readonly
+     */
+    private?: boolean | null;
+    /**
+     * Key to identify the video resolution's relationship to the original media in WixMedia.
+     * Can be used to request a download for the specific video resolution.
+     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+     * @internal
+     * @readonly
+     */
+    assetKey?: string | null;
 }
 interface EmbedMedia {
     /** Thumbnail details. */
@@ -3053,6 +3185,11 @@ interface CreateDraftPostRequest {
      * Default: `false`
      */
     publish?: boolean;
+    /**
+     * Save type.
+     * @internal
+     */
+    saveType?: TypeWithLiterals;
     /**
      * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
      * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -3081,10 +3218,21 @@ declare enum Field {
     UNKNOWN = "UNKNOWN",
     /** Includes draft post preview URL. */
     URL = "URL",
+    /**
+     * Includes internal id field.
+     * Reserved for internal use.
+     * @internal
+     */
+    INTERNAL_ID = "INTERNAL_ID",
     /** Includes content field. */
     CONTENT = "CONTENT",
     /** Includes rich content field. */
     RICH_CONTENT = "RICH_CONTENT",
+    /**
+     * Includes draft post translations when present.
+     * @internal
+     */
+    TRANSLATIONS = "TRANSLATIONS",
     /** If the user has not set excerpt, returns the one autogenerated from content. */
     GENERATED_EXCERPT = "GENERATED_EXCERPT"
 }
@@ -3103,6 +3251,11 @@ interface BulkCreateDraftPostsRequest {
     draftPosts: DraftPost[];
     /** Whether the draft post should be published after creation. */
     publish?: boolean;
+    /**
+     * Save type.
+     * @internal
+     */
+    saveType?: TypeWithLiterals;
     /** Whether to return the full created draft post entities in the response. */
     returnFullEntity?: boolean;
     /**
@@ -3166,6 +3319,11 @@ interface BulkUpdateDraftPostsRequest {
     action?: ActionWithLiterals;
     /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
     scheduledPublishDate?: Date | null;
+    /**
+     * Save type.
+     * @internal
+     */
+    saveType?: TypeWithLiterals;
     /** Whether to return the full updated draft post entities in the response. */
     returnFullEntity?: boolean;
     /**
@@ -3207,6 +3365,18 @@ interface BulkUpdateDraftPostsResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface DraftPostOwnerChanged {
+    /**
+     * Member ID of the draft post's owner before the change.
+     * @internal
+     * @format GUID
+     */
+    oldMemberId?: string;
+    /**
+     * Member ID of the draft post's owner after the change.
+     * @internal
+     * @format GUID
+     */
+    newMemberId?: string;
 }
 interface ListDeletedDraftPostsRequest {
     /**
@@ -3287,6 +3457,13 @@ interface PagingMetadataV2 {
     tooManyToCount?: boolean | null;
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
+     */
+    hasNext?: boolean | null;
 }
 interface Cursors {
     /**
@@ -3343,6 +3520,16 @@ interface UpdateDraftPostContentResponse {
 interface UpdateDraftPostRequest {
     /** Draft post to update. */
     draftPost: DraftPost;
+    /**
+     * Field mask of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
+    /**
+     * Save type.
+     * @internal
+     */
+    saveType?: TypeWithLiterals;
     /**
      * Action to perform on the post.
      *
@@ -3523,6 +3710,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
     /**
      * Origin point for geo-distance sorting on a GEO field
      * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3832,6 +4033,11 @@ interface TranslateDraftRequest {
      * @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. */
@@ -3927,6 +4133,15 @@ interface RevertToUnpublishedRequest {
      * @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.
@@ -3945,6 +4160,15 @@ interface RejectDraftPostRequest {
      * @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.
@@ -3968,6 +4192,15 @@ interface ApproveDraftPostRequest {
      * @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.
@@ -3986,6 +4219,15 @@ interface MarkPostAsInModerationRequest {
      * @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.
@@ -4380,6 +4622,25 @@ interface UpdateDraftPost {
      * @format LANGUAGE_TAG
      */
     language?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     */
+    changeOrigin?: OriginWithLiterals;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    contentId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @format GUID
+     */
+    editingSessionId?: string | null;
     /**
      * Draft Post rich content.
      *
@@ -4395,6 +4656,13 @@ interface UpdateDraftPost {
     status?: StatusWithLiterals;
     /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
     moderationDetails?: ModerationDetails;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @format GUID
+     */
+    mostRecentContributorId?: string | null;
     /**
      * Indicates if there are changes made to the draft post that have not yet been published.
      * @readonly
@@ -4410,10 +4678,23 @@ interface UpdateDraftPost {
      * @readonly
      */
     scheduledPublishDate?: Date | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     */
+    content?: Record<string, any> | null;
     /** Date the post was first published. */
     firstPublishedDate?: Date | null;
     /** SEO data. */
     seoData?: SeoSchema;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxSize 5000
+     * @maxLength 100
+     */
+    slugs?: string[];
     /**
      * Draft post URL preview. What the URL will look like once the post is published.
      * @readonly
@@ -4433,6 +4714,32 @@ interface UpdateDraftPost {
     media?: Media;
     /** Number of paragraphs to display in a paid content preview for non-paying users. */
     previewTextParagraph?: number | null;
+    /**
+     * List of the post's translated posts.
+     * @internal
+     * @readonly
+     * @maxSize 1000
+     */
+    translations?: DraftPostTranslation[];
+    /**
+     * Reserved for internal use, not included in base response.
+     * @internal
+     * @format GUID
+     */
+    originPostId?: string | null;
+    /**
+     * Reserved for internal use, not included in base response.
+     * @internal
+     * @format GUID
+     */
+    originPostInstanceId?: string | null;
+    /**
+     * Reserved for internal use.
+     * @internal
+     * @readonly
+     * @maxLength 24
+     */
+    internalId?: string | null;
 }
 interface UpdateDraftPostOptions {
     /**
@@ -4770,6 +5077,20 @@ type DraftPostQuery = {
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
         /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
+        /**
       Origin point for geo-distance sorting on a GEO field
       results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
       */

package/build/internal/cjs/index.typings.js

@@ -3716,6 +3716,7 @@ var Status = /* @__PURE__ */ ((Status2) => {
   Status2["UNPUBLISHED"] = "UNPUBLISHED";
   Status2["SCHEDULED"] = "SCHEDULED";
   Status2["DELETED"] = "DELETED";
+  Status2["IN_MODERATION"] = "IN_MODERATION";
   Status2["IN_REVIEW"] = "IN_REVIEW";
   return Status2;
 })(Status || {});
@@ -3737,8 +3738,10 @@ var Type = /* @__PURE__ */ ((Type2) => {
 var Field = /* @__PURE__ */ ((Field2) => {
   Field2["UNKNOWN"] = "UNKNOWN";
   Field2["URL"] = "URL";
+  Field2["INTERNAL_ID"] = "INTERNAL_ID";
   Field2["CONTENT"] = "CONTENT";
   Field2["RICH_CONTENT"] = "RICH_CONTENT";
+  Field2["TRANSLATIONS"] = "TRANSLATIONS";
   Field2["GENERATED_EXCERPT"] = "GENERATED_EXCERPT";
   return Field2;
 })(Field || {});