@wix/auto_sdk_blog_draft-posts 1.0.4 → 1.0.6
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.
- package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +33 -25
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js +33 -25
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +22 -22
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.types.d.ts +7 -77
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +0 -11
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +55 -166
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +22 -33
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +33 -25
- package/build/es/src/blog-v3-draft-draft-posts.http.js +33 -25
- package/build/es/src/blog-v3-draft-draft-posts.http.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +22 -22
- package/build/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +7 -77
- package/build/es/src/blog-v3-draft-draft-posts.types.js +0 -11
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.universal.d.ts +55 -166
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +22 -33
- package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +33 -25
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +33 -25
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +22 -22
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +7 -77
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +0 -11
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +55 -166
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +22 -33
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +33 -25
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +33 -25
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +22 -22
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +7 -77
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +0 -11
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.d.ts +55 -166
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +22 -33
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -32,7 +32,7 @@ export interface DraftPost {
|
|
|
32
32
|
*/
|
|
33
33
|
memberId?: string | null;
|
|
34
34
|
/**
|
|
35
|
-
* Hashtags in the post.
|
|
35
|
+
* Hashtags in the draft post.
|
|
36
36
|
* @maxSize 100
|
|
37
37
|
* @maxLength 100
|
|
38
38
|
*/
|
|
@@ -59,7 +59,7 @@ export interface DraftPost {
|
|
|
59
59
|
*/
|
|
60
60
|
relatedPostIds?: string[];
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.
|
|
63
63
|
* @maxSize 100
|
|
64
64
|
* @format GUID
|
|
65
65
|
*/
|
|
@@ -79,29 +79,7 @@ export interface DraftPost {
|
|
|
79
79
|
* @format LANGUAGE_TAG
|
|
80
80
|
*/
|
|
81
81
|
language?: string | null;
|
|
82
|
-
/**
|
|
83
|
-
* Reserved for internal use.
|
|
84
|
-
* @readonly
|
|
85
|
-
*/
|
|
86
|
-
changeOrigin?: Origin;
|
|
87
|
-
/**
|
|
88
|
-
* Reserved for internal use.
|
|
89
|
-
* @readonly
|
|
90
|
-
* @maxLength 24
|
|
91
|
-
*/
|
|
92
|
-
contentId?: string | null;
|
|
93
|
-
/**
|
|
94
|
-
* Reserved for internal use.
|
|
95
|
-
* @format GUID
|
|
96
|
-
*/
|
|
97
|
-
editingSessionId?: string | null;
|
|
98
|
-
/**
|
|
99
|
-
* Draft Post rich content.
|
|
100
|
-
*
|
|
101
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
102
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
103
|
-
* </widget>
|
|
104
|
-
*/
|
|
82
|
+
/** Draft post rich content. */
|
|
105
83
|
richContent?: RichContent;
|
|
106
84
|
/**
|
|
107
85
|
* Status of the draft post.
|
|
@@ -110,12 +88,6 @@ export interface DraftPost {
|
|
|
110
88
|
status?: Status;
|
|
111
89
|
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
112
90
|
moderationDetails?: ModerationDetails;
|
|
113
|
-
/**
|
|
114
|
-
* Reserved for internal use.
|
|
115
|
-
* @readonly
|
|
116
|
-
* @format GUID
|
|
117
|
-
*/
|
|
118
|
-
mostRecentContributorId?: string | null;
|
|
119
91
|
/**
|
|
120
92
|
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
121
93
|
* @readonly
|
|
@@ -131,26 +103,10 @@ export interface DraftPost {
|
|
|
131
103
|
* @readonly
|
|
132
104
|
*/
|
|
133
105
|
scheduledPublishDate?: Date | null;
|
|
134
|
-
/** Reserved for internal use. */
|
|
135
|
-
content?: Record<string, any> | null;
|
|
136
106
|
/** Date the post was first published. */
|
|
137
107
|
firstPublishedDate?: Date | null;
|
|
138
108
|
/** SEO data. */
|
|
139
109
|
seoData?: SeoSchema;
|
|
140
|
-
/**
|
|
141
|
-
* Reserved for internal use.
|
|
142
|
-
* @deprecated
|
|
143
|
-
* @replacedBy preview_text_paragraph
|
|
144
|
-
* @targetRemovalDate 2024-06-30
|
|
145
|
-
*/
|
|
146
|
-
paidContentParagraph?: number | null;
|
|
147
|
-
/**
|
|
148
|
-
* Reserved for internal use.
|
|
149
|
-
* @readonly
|
|
150
|
-
* @maxSize 5000
|
|
151
|
-
* @maxLength 100
|
|
152
|
-
*/
|
|
153
|
-
slugs?: string[];
|
|
154
110
|
/**
|
|
155
111
|
* Draft post URL preview. What the URL will look like once the post is published.
|
|
156
112
|
* @readonly
|
|
@@ -170,12 +126,6 @@ export interface DraftPost {
|
|
|
170
126
|
media?: Media;
|
|
171
127
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
172
128
|
previewTextParagraph?: number | null;
|
|
173
|
-
/**
|
|
174
|
-
* Reserved for internal use.
|
|
175
|
-
* @readonly
|
|
176
|
-
* @maxLength 24
|
|
177
|
-
*/
|
|
178
|
-
internalId?: string | null;
|
|
179
129
|
}
|
|
180
130
|
export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
181
131
|
/** Image url. */
|
|
@@ -196,7 +146,12 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
|
196
146
|
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
|
|
197
147
|
custom?: boolean;
|
|
198
148
|
/**
|
|
199
|
-
*
|
|
149
|
+
* Alternative text is a short phrase that describes what the image depicts.
|
|
150
|
+
*
|
|
151
|
+
* The alternative text is used:
|
|
152
|
+
* + If the browser cannot display the image.
|
|
153
|
+
* + If the user is utilizing a screen reader.
|
|
154
|
+
* + By search engines to understand what images are on a site.
|
|
200
155
|
* @minLength 1
|
|
201
156
|
* @maxLength 1000
|
|
202
157
|
*/
|
|
@@ -576,7 +531,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
576
531
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
577
532
|
anchor?: string;
|
|
578
533
|
/**
|
|
579
|
-
*
|
|
534
|
+
* The HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
580
535
|
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
581
536
|
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
582
537
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
@@ -612,7 +567,7 @@ export interface Rel {
|
|
|
612
567
|
sponsored?: boolean | null;
|
|
613
568
|
/** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
|
|
614
569
|
ugc?: boolean | null;
|
|
615
|
-
/** Indicates that this link
|
|
570
|
+
/** Indicates that this link protects referral information from being passed to the target website. */
|
|
616
571
|
noreferrer?: boolean | null;
|
|
617
572
|
}
|
|
618
573
|
export interface CodeBlockData {
|
|
@@ -1663,12 +1618,6 @@ export declare enum Status {
|
|
|
1663
1618
|
SCHEDULED = "SCHEDULED",
|
|
1664
1619
|
/** Status indicating the draft post is deleted. */
|
|
1665
1620
|
DELETED = "DELETED",
|
|
1666
|
-
/**
|
|
1667
|
-
* Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.
|
|
1668
|
-
* Target removal date 2024-06-30
|
|
1669
|
-
* Reserved for internal use.
|
|
1670
|
-
*/
|
|
1671
|
-
IN_MODERATION = "IN_MODERATION",
|
|
1672
1621
|
/** Status indicating the draft post is in review. */
|
|
1673
1622
|
IN_REVIEW = "IN_REVIEW"
|
|
1674
1623
|
}
|
|
@@ -2095,11 +2044,6 @@ export declare enum Field {
|
|
|
2095
2044
|
UNKNOWN = "UNKNOWN",
|
|
2096
2045
|
/** Includes draft post preview URL. */
|
|
2097
2046
|
URL = "URL",
|
|
2098
|
-
/**
|
|
2099
|
-
* Includes internal id field.
|
|
2100
|
-
* Reserved for internal use.
|
|
2101
|
-
*/
|
|
2102
|
-
INTERNAL_ID = "INTERNAL_ID",
|
|
2103
2047
|
/** Includes content field. */
|
|
2104
2048
|
CONTENT = "CONTENT",
|
|
2105
2049
|
/** Includes rich content field. */
|
|
@@ -2178,6 +2122,14 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2178
2122
|
/**
|
|
2179
2123
|
* Action to perform on the posts.
|
|
2180
2124
|
*
|
|
2125
|
+
* - `UPDATE`: Update the draft post.
|
|
2126
|
+
* - `UPDATE_PUBLISH`: Update and publish the draft post.
|
|
2127
|
+
* - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
|
|
2128
|
+
* - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
|
|
2129
|
+
* - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
|
|
2130
|
+
* - `UPDATE_REJECT`: Update and reject the draft post.
|
|
2131
|
+
* - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
|
|
2132
|
+
*
|
|
2181
2133
|
* Default: `UPDATE`
|
|
2182
2134
|
*/
|
|
2183
2135
|
action?: Action;
|
|
@@ -2194,7 +2146,7 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2194
2146
|
fieldsets?: Field[];
|
|
2195
2147
|
}
|
|
2196
2148
|
export interface MaskedDraftPosts {
|
|
2197
|
-
/** Draft post */
|
|
2149
|
+
/** Draft post info. */
|
|
2198
2150
|
draftPost?: DraftPost;
|
|
2199
2151
|
/** Field mask of fields to update. */
|
|
2200
2152
|
fieldMask?: string[];
|
|
@@ -2326,7 +2278,7 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
|
|
|
2326
2278
|
* @maxLength 400000
|
|
2327
2279
|
*/
|
|
2328
2280
|
content?: string;
|
|
2329
|
-
/** Draft
|
|
2281
|
+
/** Draft post rich content. */
|
|
2330
2282
|
richContent?: RichContent;
|
|
2331
2283
|
/**
|
|
2332
2284
|
* Draft post ID.
|
|
@@ -2350,7 +2302,7 @@ export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
|
2350
2302
|
* @maxLength 400000
|
|
2351
2303
|
*/
|
|
2352
2304
|
content?: string;
|
|
2353
|
-
/** Draft
|
|
2305
|
+
/** Draft post rich content. */
|
|
2354
2306
|
richContent?: RichContent;
|
|
2355
2307
|
}
|
|
2356
2308
|
export interface UpdateDraftPostContentResponse {
|
|
@@ -2426,7 +2378,6 @@ export interface ListDraftPostsRequest {
|
|
|
2426
2378
|
* Draft post status filter.
|
|
2427
2379
|
*
|
|
2428
2380
|
* If omitted, draft posts with all statuses are returned.
|
|
2429
|
-
* `IN_MODERATION` is deprecated, use `IN_REVIEW` instead.
|
|
2430
2381
|
*/
|
|
2431
2382
|
status?: Status;
|
|
2432
2383
|
/**
|
|
@@ -2561,19 +2512,6 @@ export interface CursorPaging {
|
|
|
2561
2512
|
export interface QueryDraftPostsResponse {
|
|
2562
2513
|
/** List of posts. */
|
|
2563
2514
|
draftPosts?: DraftPost[];
|
|
2564
|
-
/**
|
|
2565
|
-
* __Deprecated.__ Use `pagingMetadata` instead.
|
|
2566
|
-
* This property will be removed on June 30, 2023.
|
|
2567
|
-
*
|
|
2568
|
-
* Details on the paged set of results returned.
|
|
2569
|
-
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
|
|
2570
|
-
* This property will be removed on June 30, 2023.
|
|
2571
|
-
*
|
|
2572
|
-
* Details on the paged set of results returned.
|
|
2573
|
-
* @replacedBy pagingMetadata
|
|
2574
|
-
* @targetRemovalDate 2024-06-30
|
|
2575
|
-
*/
|
|
2576
|
-
metaData?: MetaData;
|
|
2577
2515
|
/** Details on the paged set of results returned. */
|
|
2578
2516
|
pagingMetadata?: PagingMetadataV2;
|
|
2579
2517
|
}
|
|
@@ -2700,12 +2638,6 @@ export interface Category {
|
|
|
2700
2638
|
* @maxLength 100
|
|
2701
2639
|
*/
|
|
2702
2640
|
slug?: string;
|
|
2703
|
-
/**
|
|
2704
|
-
* Reserved for internal use.
|
|
2705
|
-
* @readonly
|
|
2706
|
-
* @maxLength 24
|
|
2707
|
-
*/
|
|
2708
|
-
internalId?: string | null;
|
|
2709
2641
|
/** SEO data. */
|
|
2710
2642
|
seoData?: SeoSchema;
|
|
2711
2643
|
/** Category cover image. */
|
|
@@ -3497,7 +3429,7 @@ export declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) =>
|
|
|
3497
3429
|
/**
|
|
3498
3430
|
* Creates a draft post.
|
|
3499
3431
|
*
|
|
3500
|
-
*
|
|
3432
|
+
* The draft post's `memberId` is required for third-party apps.
|
|
3501
3433
|
* @param draftPost - Draft post to create.
|
|
3502
3434
|
* @public
|
|
3503
3435
|
* @requiredField draftPost
|
|
@@ -3575,6 +3507,14 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3575
3507
|
/**
|
|
3576
3508
|
* Action to perform on the posts.
|
|
3577
3509
|
*
|
|
3510
|
+
* - `UPDATE`: Update the draft post.
|
|
3511
|
+
* - `UPDATE_PUBLISH`: Update and publish the draft post.
|
|
3512
|
+
* - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
|
|
3513
|
+
* - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
|
|
3514
|
+
* - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
|
|
3515
|
+
* - `UPDATE_REJECT`: Update and reject the draft post.
|
|
3516
|
+
* - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
|
|
3517
|
+
*
|
|
3578
3518
|
* Default: `UPDATE`
|
|
3579
3519
|
*/
|
|
3580
3520
|
action?: Action;
|
|
@@ -3593,7 +3533,7 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3593
3533
|
/**
|
|
3594
3534
|
* Retrieves a list of up to 100 deleted draft posts.
|
|
3595
3535
|
*
|
|
3596
|
-
* List Draft Posts runs with these defaults, which you can override:
|
|
3536
|
+
* List Deleted Draft Posts runs with these defaults, which you can override:
|
|
3597
3537
|
* - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
|
|
3598
3538
|
* - `paging.limit` is `50`.
|
|
3599
3539
|
* - `paging.offset` is `0`.
|
|
@@ -3639,6 +3579,8 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3639
3579
|
}
|
|
3640
3580
|
/**
|
|
3641
3581
|
* Gets a draft post by the provided ID.
|
|
3582
|
+
*
|
|
3583
|
+
* Uses the provided `draftPostId` to retrieve a draft post.
|
|
3642
3584
|
* @param draftPostId - Draft post ID.
|
|
3643
3585
|
* @public
|
|
3644
3586
|
* @requiredField draftPostId
|
|
@@ -3708,7 +3650,7 @@ export interface UpdateDraftPost {
|
|
|
3708
3650
|
*/
|
|
3709
3651
|
memberId?: string | null;
|
|
3710
3652
|
/**
|
|
3711
|
-
* Hashtags in the post.
|
|
3653
|
+
* Hashtags in the draft post.
|
|
3712
3654
|
* @maxSize 100
|
|
3713
3655
|
* @maxLength 100
|
|
3714
3656
|
*/
|
|
@@ -3735,7 +3677,7 @@ export interface UpdateDraftPost {
|
|
|
3735
3677
|
*/
|
|
3736
3678
|
relatedPostIds?: string[];
|
|
3737
3679
|
/**
|
|
3738
|
-
*
|
|
3680
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.
|
|
3739
3681
|
* @maxSize 100
|
|
3740
3682
|
* @format GUID
|
|
3741
3683
|
*/
|
|
@@ -3755,29 +3697,7 @@ export interface UpdateDraftPost {
|
|
|
3755
3697
|
* @format LANGUAGE_TAG
|
|
3756
3698
|
*/
|
|
3757
3699
|
language?: string | null;
|
|
3758
|
-
/**
|
|
3759
|
-
* Reserved for internal use.
|
|
3760
|
-
* @readonly
|
|
3761
|
-
*/
|
|
3762
|
-
changeOrigin?: Origin;
|
|
3763
|
-
/**
|
|
3764
|
-
* Reserved for internal use.
|
|
3765
|
-
* @readonly
|
|
3766
|
-
* @maxLength 24
|
|
3767
|
-
*/
|
|
3768
|
-
contentId?: string | null;
|
|
3769
|
-
/**
|
|
3770
|
-
* Reserved for internal use.
|
|
3771
|
-
* @format GUID
|
|
3772
|
-
*/
|
|
3773
|
-
editingSessionId?: string | null;
|
|
3774
|
-
/**
|
|
3775
|
-
* Draft Post rich content.
|
|
3776
|
-
*
|
|
3777
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
|
3778
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
|
3779
|
-
* </widget>
|
|
3780
|
-
*/
|
|
3700
|
+
/** Draft post rich content. */
|
|
3781
3701
|
richContent?: RichContent;
|
|
3782
3702
|
/**
|
|
3783
3703
|
* Status of the draft post.
|
|
@@ -3786,12 +3706,6 @@ export interface UpdateDraftPost {
|
|
|
3786
3706
|
status?: Status;
|
|
3787
3707
|
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3788
3708
|
moderationDetails?: ModerationDetails;
|
|
3789
|
-
/**
|
|
3790
|
-
* Reserved for internal use.
|
|
3791
|
-
* @readonly
|
|
3792
|
-
* @format GUID
|
|
3793
|
-
*/
|
|
3794
|
-
mostRecentContributorId?: string | null;
|
|
3795
3709
|
/**
|
|
3796
3710
|
* Indicates if there are changes made to the draft post that have not yet been published.
|
|
3797
3711
|
* @readonly
|
|
@@ -3807,26 +3721,10 @@ export interface UpdateDraftPost {
|
|
|
3807
3721
|
* @readonly
|
|
3808
3722
|
*/
|
|
3809
3723
|
scheduledPublishDate?: Date | null;
|
|
3810
|
-
/** Reserved for internal use. */
|
|
3811
|
-
content?: Record<string, any> | null;
|
|
3812
3724
|
/** Date the post was first published. */
|
|
3813
3725
|
firstPublishedDate?: Date | null;
|
|
3814
3726
|
/** SEO data. */
|
|
3815
3727
|
seoData?: SeoSchema;
|
|
3816
|
-
/**
|
|
3817
|
-
* Reserved for internal use.
|
|
3818
|
-
* @deprecated
|
|
3819
|
-
* @replacedBy preview_text_paragraph
|
|
3820
|
-
* @targetRemovalDate 2024-06-30
|
|
3821
|
-
*/
|
|
3822
|
-
paidContentParagraph?: number | null;
|
|
3823
|
-
/**
|
|
3824
|
-
* Reserved for internal use.
|
|
3825
|
-
* @readonly
|
|
3826
|
-
* @maxSize 5000
|
|
3827
|
-
* @maxLength 100
|
|
3828
|
-
*/
|
|
3829
|
-
slugs?: string[];
|
|
3830
3728
|
/**
|
|
3831
3729
|
* Draft post URL preview. What the URL will look like once the post is published.
|
|
3832
3730
|
* @readonly
|
|
@@ -3846,12 +3744,6 @@ export interface UpdateDraftPost {
|
|
|
3846
3744
|
media?: Media;
|
|
3847
3745
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
3848
3746
|
previewTextParagraph?: number | null;
|
|
3849
|
-
/**
|
|
3850
|
-
* Reserved for internal use.
|
|
3851
|
-
* @readonly
|
|
3852
|
-
* @maxLength 24
|
|
3853
|
-
*/
|
|
3854
|
-
internalId?: string | null;
|
|
3855
3747
|
}
|
|
3856
3748
|
export interface UpdateDraftPostOptions {
|
|
3857
3749
|
/**
|
|
@@ -3871,10 +3763,10 @@ export interface UpdateDraftPostOptions {
|
|
|
3871
3763
|
fieldsets?: Field[];
|
|
3872
3764
|
}
|
|
3873
3765
|
/**
|
|
3874
|
-
* Moves a draft post to the trash bin.
|
|
3875
|
-
* A published post can also be deleted by
|
|
3766
|
+
* Moves a draft post with the provided ID to the trash bin.
|
|
3767
|
+
* A published post can also be deleted by its provided `draftPostId`.
|
|
3876
3768
|
*
|
|
3877
|
-
*
|
|
3769
|
+
* The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
|
|
3878
3770
|
* @param draftPostId - Draft post ID.
|
|
3879
3771
|
* @public
|
|
3880
3772
|
* @requiredField draftPostId
|
|
@@ -3895,7 +3787,9 @@ export interface DeleteDraftPostOptions {
|
|
|
3895
3787
|
permanent?: boolean;
|
|
3896
3788
|
}
|
|
3897
3789
|
/**
|
|
3898
|
-
* Permanently deletes a draft post
|
|
3790
|
+
* Permanently deletes a draft post by the provided ID from the trash bin.
|
|
3791
|
+
*
|
|
3792
|
+
* Uses the provided `draftPostId` to permanently delete a draft post from the trash bin. This action is permanent and cannot be reversed.
|
|
3899
3793
|
* @param draftPostId - Draft post ID.
|
|
3900
3794
|
* @public
|
|
3901
3795
|
* @requiredField draftPostId
|
|
@@ -3944,7 +3838,6 @@ export interface ListDraftPostsOptions {
|
|
|
3944
3838
|
* Draft post status filter.
|
|
3945
3839
|
*
|
|
3946
3840
|
* If omitted, draft posts with all statuses are returned.
|
|
3947
|
-
* `IN_MODERATION` is deprecated, use `IN_REVIEW` instead.
|
|
3948
3841
|
*/
|
|
3949
3842
|
status?: Status;
|
|
3950
3843
|
/**
|
|
@@ -3973,6 +3866,8 @@ export interface ListDraftPostsOptions {
|
|
|
3973
3866
|
}
|
|
3974
3867
|
/**
|
|
3975
3868
|
* Gets a deleted draft post from the trash bin by the provided ID.
|
|
3869
|
+
*
|
|
3870
|
+
* Uses the provided `draftPostId` to retrieve a previously deleted draft post from the trash bin.
|
|
3976
3871
|
* @param draftPostId - Draft post ID.
|
|
3977
3872
|
* @public
|
|
3978
3873
|
* @requiredField draftPostId
|
|
@@ -3985,6 +3880,8 @@ export interface ListDraftPostsOptions {
|
|
|
3985
3880
|
export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDeletedDraftPostResponse & GetDeletedDraftPostResponseNonNullableFields>;
|
|
3986
3881
|
/**
|
|
3987
3882
|
* Restores a deleted draft post from the trash bin by the provided ID.
|
|
3883
|
+
*
|
|
3884
|
+
* Uses the `draftPostId` to restore a deleted draft post from the trash bin.
|
|
3988
3885
|
* @param draftPostId - Draft post ID.
|
|
3989
3886
|
* @public
|
|
3990
3887
|
* @requiredField draftPostId
|
|
@@ -3996,20 +3893,12 @@ export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDel
|
|
|
3996
3893
|
*/
|
|
3997
3894
|
export declare function restoreFromTrashBin(draftPostId: string): Promise<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
|
|
3998
3895
|
/**
|
|
3999
|
-
*
|
|
4000
|
-
*
|
|
4001
|
-
*
|
|
4002
|
-
* The `queryDraftPosts()` function builds a query to retrieve a list of up to 100 draft posts, and returns a `DraftPostsQueryBuilder` object.
|
|
4003
|
-
*
|
|
4004
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
3896
|
+
* Retrieves a list of up to 100 draft posts, given the provided paging, filtering, and sorting.
|
|
4005
3897
|
*
|
|
4006
|
-
*
|
|
4007
|
-
*
|
|
4008
|
-
* `
|
|
4009
|
-
* - `
|
|
4010
|
-
* - `ascending('_id')`
|
|
4011
|
-
*
|
|
4012
|
-
* 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`.
|
|
3898
|
+
* Query Draft Posts runs with these defaults, which you can override:
|
|
3899
|
+
* - `editedDate` is sorted in `DESC` order.
|
|
3900
|
+
* - `paging.limit` is `50`.
|
|
3901
|
+
* - `paging.offset` is `0`.
|
|
4013
3902
|
* @public
|
|
4014
3903
|
* @param options - Options for querying draft posts.
|
|
4015
3904
|
* @permissionScope Manage Blog
|
|
@@ -4083,9 +3972,9 @@ export interface DraftPostsQueryBuilder {
|
|
|
4083
3972
|
find: () => Promise<DraftPostsQueryResult>;
|
|
4084
3973
|
}
|
|
4085
3974
|
/**
|
|
4086
|
-
* Publishes a specified draft post by ID. This creates a new
|
|
4087
|
-
*
|
|
4088
|
-
* from the draft post entity.
|
|
3975
|
+
* Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
|
|
3976
|
+
*
|
|
3977
|
+
* If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
|
|
4089
3978
|
* @param draftPostId - Draft post ID.
|
|
4090
3979
|
* @public
|
|
4091
3980
|
* @requiredField draftPostId
|
|
@@ -431,12 +431,6 @@ var Status;
|
|
|
431
431
|
Status["SCHEDULED"] = "SCHEDULED";
|
|
432
432
|
/** Status indicating the draft post is deleted. */
|
|
433
433
|
Status["DELETED"] = "DELETED";
|
|
434
|
-
/**
|
|
435
|
-
* Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.
|
|
436
|
-
* Target removal date 2024-06-30
|
|
437
|
-
* Reserved for internal use.
|
|
438
|
-
*/
|
|
439
|
-
Status["IN_MODERATION"] = "IN_MODERATION";
|
|
440
434
|
/** Status indicating the draft post is in review. */
|
|
441
435
|
Status["IN_REVIEW"] = "IN_REVIEW";
|
|
442
436
|
})(Status || (exports.Status = Status = {}));
|
|
@@ -481,11 +475,6 @@ var Field;
|
|
|
481
475
|
Field["UNKNOWN"] = "UNKNOWN";
|
|
482
476
|
/** Includes draft post preview URL. */
|
|
483
477
|
Field["URL"] = "URL";
|
|
484
|
-
/**
|
|
485
|
-
* Includes internal id field.
|
|
486
|
-
* Reserved for internal use.
|
|
487
|
-
*/
|
|
488
|
-
Field["INTERNAL_ID"] = "INTERNAL_ID";
|
|
489
478
|
/** Includes content field. */
|
|
490
479
|
Field["CONTENT"] = "CONTENT";
|
|
491
480
|
/** Includes rich content field. */
|
|
@@ -525,7 +514,7 @@ var SortOrder;
|
|
|
525
514
|
/**
|
|
526
515
|
* Creates a draft post.
|
|
527
516
|
*
|
|
528
|
-
*
|
|
517
|
+
* The draft post's `memberId` is required for third-party apps.
|
|
529
518
|
* @param draftPost - Draft post to create.
|
|
530
519
|
* @public
|
|
531
520
|
* @requiredField draftPost
|
|
@@ -805,7 +794,7 @@ exports.bulkUpdateDraftPosts = bulkUpdateDraftPosts;
|
|
|
805
794
|
/**
|
|
806
795
|
* Retrieves a list of up to 100 deleted draft posts.
|
|
807
796
|
*
|
|
808
|
-
* List Draft Posts runs with these defaults, which you can override:
|
|
797
|
+
* List Deleted Draft Posts runs with these defaults, which you can override:
|
|
809
798
|
* - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
|
|
810
799
|
* - `paging.limit` is `50`.
|
|
811
800
|
* - `paging.offset` is `0`.
|
|
@@ -877,6 +866,8 @@ async function listDeletedDraftPosts(options) {
|
|
|
877
866
|
exports.listDeletedDraftPosts = listDeletedDraftPosts;
|
|
878
867
|
/**
|
|
879
868
|
* Gets a draft post by the provided ID.
|
|
869
|
+
*
|
|
870
|
+
* Uses the provided `draftPostId` to retrieve a draft post.
|
|
880
871
|
* @param draftPostId - Draft post ID.
|
|
881
872
|
* @public
|
|
882
873
|
* @requiredField draftPostId
|
|
@@ -1034,10 +1025,10 @@ async function updateDraftPost(_id, draftPost, options) {
|
|
|
1034
1025
|
}
|
|
1035
1026
|
exports.updateDraftPost = updateDraftPost;
|
|
1036
1027
|
/**
|
|
1037
|
-
* Moves a draft post to the trash bin.
|
|
1038
|
-
* A published post can also be deleted by
|
|
1028
|
+
* Moves a draft post with the provided ID to the trash bin.
|
|
1029
|
+
* A published post can also be deleted by its provided `draftPostId`.
|
|
1039
1030
|
*
|
|
1040
|
-
*
|
|
1031
|
+
* The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
|
|
1041
1032
|
* @param draftPostId - Draft post ID.
|
|
1042
1033
|
* @public
|
|
1043
1034
|
* @requiredField draftPostId
|
|
@@ -1076,7 +1067,9 @@ async function deleteDraftPost(draftPostId, options) {
|
|
|
1076
1067
|
}
|
|
1077
1068
|
exports.deleteDraftPost = deleteDraftPost;
|
|
1078
1069
|
/**
|
|
1079
|
-
* Permanently deletes a draft post
|
|
1070
|
+
* Permanently deletes a draft post by the provided ID from the trash bin.
|
|
1071
|
+
*
|
|
1072
|
+
* Uses the provided `draftPostId` to permanently delete a draft post from the trash bin. This action is permanent and cannot be reversed.
|
|
1080
1073
|
* @param draftPostId - Draft post ID.
|
|
1081
1074
|
* @public
|
|
1082
1075
|
* @requiredField draftPostId
|
|
@@ -1248,6 +1241,8 @@ async function listDraftPosts(options) {
|
|
|
1248
1241
|
exports.listDraftPosts = listDraftPosts;
|
|
1249
1242
|
/**
|
|
1250
1243
|
* Gets a deleted draft post from the trash bin by the provided ID.
|
|
1244
|
+
*
|
|
1245
|
+
* Uses the provided `draftPostId` to retrieve a previously deleted draft post from the trash bin.
|
|
1251
1246
|
* @param draftPostId - Draft post ID.
|
|
1252
1247
|
* @public
|
|
1253
1248
|
* @requiredField draftPostId
|
|
@@ -1307,6 +1302,8 @@ async function getDeletedDraftPost(draftPostId) {
|
|
|
1307
1302
|
exports.getDeletedDraftPost = getDeletedDraftPost;
|
|
1308
1303
|
/**
|
|
1309
1304
|
* Restores a deleted draft post from the trash bin by the provided ID.
|
|
1305
|
+
*
|
|
1306
|
+
* Uses the `draftPostId` to restore a deleted draft post from the trash bin.
|
|
1310
1307
|
* @param draftPostId - Draft post ID.
|
|
1311
1308
|
* @public
|
|
1312
1309
|
* @requiredField draftPostId
|
|
@@ -1365,20 +1362,12 @@ async function restoreFromTrashBin(draftPostId) {
|
|
|
1365
1362
|
}
|
|
1366
1363
|
exports.restoreFromTrashBin = restoreFromTrashBin;
|
|
1367
1364
|
/**
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1371
|
-
* The `queryDraftPosts()` function builds a query to retrieve a list of up to 100 draft posts, and returns a `DraftPostsQueryBuilder` object.
|
|
1365
|
+
* Retrieves a list of up to 100 draft posts, given the provided paging, filtering, and sorting.
|
|
1372
1366
|
*
|
|
1373
|
-
*
|
|
1374
|
-
*
|
|
1375
|
-
*
|
|
1376
|
-
*
|
|
1377
|
-
* `queryDraftPosts()` runs with these `DraftPostsQueryBuilder` defaults that can be overridden:
|
|
1378
|
-
* - `limit(50)`
|
|
1379
|
-
* - `ascending('_id')`
|
|
1380
|
-
*
|
|
1381
|
-
* 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`.
|
|
1367
|
+
* Query Draft Posts runs with these defaults, which you can override:
|
|
1368
|
+
* - `editedDate` is sorted in `DESC` order.
|
|
1369
|
+
* - `paging.limit` is `50`.
|
|
1370
|
+
* - `paging.offset` is `0`.
|
|
1382
1371
|
* @public
|
|
1383
1372
|
* @param options - Options for querying draft posts.
|
|
1384
1373
|
* @permissionScope Manage Blog
|
|
@@ -1459,9 +1448,9 @@ function queryDraftPosts(options) {
|
|
|
1459
1448
|
}
|
|
1460
1449
|
exports.queryDraftPosts = queryDraftPosts;
|
|
1461
1450
|
/**
|
|
1462
|
-
* Publishes a specified draft post by ID. This creates a new
|
|
1463
|
-
*
|
|
1464
|
-
* from the draft post entity.
|
|
1451
|
+
* Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
|
|
1452
|
+
*
|
|
1453
|
+
* If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
|
|
1465
1454
|
* @param draftPostId - Draft post ID.
|
|
1466
1455
|
* @public
|
|
1467
1456
|
* @requiredField draftPostId
|