@wix/auto_sdk_blog_draft-posts 1.0.102 → 1.0.104
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/index.d.ts +11 -11
- package/build/cjs/index.js +13 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +284 -284
- package/build/cjs/index.typings.js +13 -13
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +274 -274
- package/build/cjs/meta.js +13 -13
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -11
- package/build/es/index.mjs +13 -13
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +284 -284
- package/build/es/index.typings.mjs +13 -13
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +274 -274
- package/build/es/meta.mjs +13 -13
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -11
- package/build/internal/cjs/index.typings.d.ts +313 -313
- package/build/internal/cjs/meta.d.ts +321 -321
- package/build/internal/es/index.d.mts +11 -11
- package/build/internal/es/index.typings.d.mts +313 -313
- package/build/internal/es/meta.d.mts +321 -321
- package/package.json +2 -2
|
@@ -3200,10 +3200,6 @@ interface DraftPostTranslation {
|
|
|
3200
3200
|
/** Post URL. */
|
|
3201
3201
|
url?: string;
|
|
3202
3202
|
}
|
|
3203
|
-
interface InitialDraftPostsCopied {
|
|
3204
|
-
/** Number of draft posts copied. */
|
|
3205
|
-
count?: number;
|
|
3206
|
-
}
|
|
3207
3203
|
interface DraftCategoriesUpdated {
|
|
3208
3204
|
/**
|
|
3209
3205
|
* Draft post ID.
|
|
@@ -3242,6 +3238,200 @@ interface DraftTagsUpdated {
|
|
|
3242
3238
|
*/
|
|
3243
3239
|
previousTags?: string[];
|
|
3244
3240
|
}
|
|
3241
|
+
interface GetDraftPostTotalsRequest {
|
|
3242
|
+
/**
|
|
3243
|
+
* Group results by fields (defaults to grouping by status).
|
|
3244
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
3245
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
3246
|
+
* @maxSize 10
|
|
3247
|
+
*/
|
|
3248
|
+
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
3249
|
+
/**
|
|
3250
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
3251
|
+
* @format LANGUAGE_TAG
|
|
3252
|
+
*/
|
|
3253
|
+
language?: string | null;
|
|
3254
|
+
}
|
|
3255
|
+
declare enum TotalDraftPostsGroupingField {
|
|
3256
|
+
/** Groups results by status. */
|
|
3257
|
+
STATUS = "STATUS",
|
|
3258
|
+
/** Groups results by language. */
|
|
3259
|
+
LANGUAGE = "LANGUAGE"
|
|
3260
|
+
}
|
|
3261
|
+
/** @enumType */
|
|
3262
|
+
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
3263
|
+
interface GetDraftPostTotalsResponse {
|
|
3264
|
+
/** Draft post totals. */
|
|
3265
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
3266
|
+
}
|
|
3267
|
+
interface TotalDraftPosts {
|
|
3268
|
+
/** Draft post totals in that group. */
|
|
3269
|
+
total?: number;
|
|
3270
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
3271
|
+
status?: StatusWithLiterals;
|
|
3272
|
+
/**
|
|
3273
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
3274
|
+
* @format LANGUAGE_TAG
|
|
3275
|
+
*/
|
|
3276
|
+
language?: string | null;
|
|
3277
|
+
}
|
|
3278
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3279
|
+
createdEvent?: EntityCreatedEvent;
|
|
3280
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3281
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3282
|
+
actionEvent?: ActionEvent;
|
|
3283
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3284
|
+
_id?: string;
|
|
3285
|
+
/**
|
|
3286
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3287
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3288
|
+
*/
|
|
3289
|
+
entityFqdn?: string;
|
|
3290
|
+
/**
|
|
3291
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3292
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3293
|
+
*/
|
|
3294
|
+
slug?: string;
|
|
3295
|
+
/** ID of the entity associated with the event. */
|
|
3296
|
+
entityId?: string;
|
|
3297
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3298
|
+
eventTime?: Date | null;
|
|
3299
|
+
/**
|
|
3300
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3301
|
+
* (for example, GDPR).
|
|
3302
|
+
*/
|
|
3303
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3304
|
+
/** If present, indicates the action that triggered the event. */
|
|
3305
|
+
originatedFrom?: string | null;
|
|
3306
|
+
/**
|
|
3307
|
+
* 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.
|
|
3308
|
+
* 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.
|
|
3309
|
+
*/
|
|
3310
|
+
entityEventSequence?: string | null;
|
|
3311
|
+
}
|
|
3312
|
+
/** @oneof */
|
|
3313
|
+
interface DomainEventBodyOneOf {
|
|
3314
|
+
createdEvent?: EntityCreatedEvent;
|
|
3315
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3316
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3317
|
+
actionEvent?: ActionEvent;
|
|
3318
|
+
}
|
|
3319
|
+
interface EntityCreatedEvent {
|
|
3320
|
+
entity?: string;
|
|
3321
|
+
}
|
|
3322
|
+
interface RestoreInfo {
|
|
3323
|
+
deletedDate?: Date | null;
|
|
3324
|
+
}
|
|
3325
|
+
interface EntityUpdatedEvent {
|
|
3326
|
+
/**
|
|
3327
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3328
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3329
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3330
|
+
*/
|
|
3331
|
+
currentEntity?: string;
|
|
3332
|
+
}
|
|
3333
|
+
interface EntityDeletedEvent {
|
|
3334
|
+
/** Entity that was deleted. */
|
|
3335
|
+
deletedEntity?: string | null;
|
|
3336
|
+
}
|
|
3337
|
+
interface ActionEvent {
|
|
3338
|
+
body?: string;
|
|
3339
|
+
}
|
|
3340
|
+
interface MessageEnvelope {
|
|
3341
|
+
/**
|
|
3342
|
+
* App instance ID.
|
|
3343
|
+
* @format GUID
|
|
3344
|
+
*/
|
|
3345
|
+
instanceId?: string | null;
|
|
3346
|
+
/**
|
|
3347
|
+
* Event type.
|
|
3348
|
+
* @maxLength 150
|
|
3349
|
+
*/
|
|
3350
|
+
eventType?: string;
|
|
3351
|
+
/** The identification type and identity data. */
|
|
3352
|
+
identity?: IdentificationData;
|
|
3353
|
+
/** Stringify payload. */
|
|
3354
|
+
data?: string;
|
|
3355
|
+
/** Details related to the account */
|
|
3356
|
+
accountInfo?: AccountInfo;
|
|
3357
|
+
}
|
|
3358
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3359
|
+
/**
|
|
3360
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3361
|
+
* @format GUID
|
|
3362
|
+
*/
|
|
3363
|
+
anonymousVisitorId?: string;
|
|
3364
|
+
/**
|
|
3365
|
+
* ID of a site visitor that has logged in to the site.
|
|
3366
|
+
* @format GUID
|
|
3367
|
+
*/
|
|
3368
|
+
memberId?: string;
|
|
3369
|
+
/**
|
|
3370
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3371
|
+
* @format GUID
|
|
3372
|
+
*/
|
|
3373
|
+
wixUserId?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* ID of an app.
|
|
3376
|
+
* @format GUID
|
|
3377
|
+
*/
|
|
3378
|
+
appId?: string;
|
|
3379
|
+
/** @readonly */
|
|
3380
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3381
|
+
}
|
|
3382
|
+
/** @oneof */
|
|
3383
|
+
interface IdentificationDataIdOneOf {
|
|
3384
|
+
/**
|
|
3385
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3386
|
+
* @format GUID
|
|
3387
|
+
*/
|
|
3388
|
+
anonymousVisitorId?: string;
|
|
3389
|
+
/**
|
|
3390
|
+
* ID of a site visitor that has logged in to the site.
|
|
3391
|
+
* @format GUID
|
|
3392
|
+
*/
|
|
3393
|
+
memberId?: string;
|
|
3394
|
+
/**
|
|
3395
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3396
|
+
* @format GUID
|
|
3397
|
+
*/
|
|
3398
|
+
wixUserId?: string;
|
|
3399
|
+
/**
|
|
3400
|
+
* ID of an app.
|
|
3401
|
+
* @format GUID
|
|
3402
|
+
*/
|
|
3403
|
+
appId?: string;
|
|
3404
|
+
}
|
|
3405
|
+
declare enum WebhookIdentityType {
|
|
3406
|
+
UNKNOWN = "UNKNOWN",
|
|
3407
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3408
|
+
MEMBER = "MEMBER",
|
|
3409
|
+
WIX_USER = "WIX_USER",
|
|
3410
|
+
APP = "APP"
|
|
3411
|
+
}
|
|
3412
|
+
/** @enumType */
|
|
3413
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3414
|
+
interface AccountInfo {
|
|
3415
|
+
/**
|
|
3416
|
+
* ID of the Wix account associated with the event.
|
|
3417
|
+
* @format GUID
|
|
3418
|
+
*/
|
|
3419
|
+
accountId?: string | null;
|
|
3420
|
+
/**
|
|
3421
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3422
|
+
* @format GUID
|
|
3423
|
+
*/
|
|
3424
|
+
parentAccountId?: string | null;
|
|
3425
|
+
/**
|
|
3426
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3427
|
+
* @format GUID
|
|
3428
|
+
*/
|
|
3429
|
+
siteId?: string | null;
|
|
3430
|
+
}
|
|
3431
|
+
interface InitialDraftPostsCopied {
|
|
3432
|
+
/** Number of draft posts copied. */
|
|
3433
|
+
count?: number;
|
|
3434
|
+
}
|
|
3245
3435
|
interface CreateDraftPostRequest {
|
|
3246
3436
|
/** Draft post to create. */
|
|
3247
3437
|
draftPost: DraftPost;
|
|
@@ -3822,195 +4012,116 @@ interface DraftPostCount {
|
|
|
3822
4012
|
/** Number of posts. */
|
|
3823
4013
|
postCount?: number;
|
|
3824
4014
|
}
|
|
3825
|
-
interface
|
|
3826
|
-
createdEvent?: EntityCreatedEvent;
|
|
3827
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3828
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3829
|
-
actionEvent?: ActionEvent;
|
|
3830
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3831
|
-
_id?: string;
|
|
4015
|
+
interface BulkRevertToUnpublishedRequest {
|
|
3832
4016
|
/**
|
|
3833
|
-
*
|
|
3834
|
-
*
|
|
4017
|
+
* Source post IDs.
|
|
4018
|
+
* @minSize 1
|
|
4019
|
+
* @maxSize 100
|
|
4020
|
+
* @format GUID
|
|
3835
4021
|
*/
|
|
3836
|
-
|
|
4022
|
+
postIds?: string[];
|
|
4023
|
+
/** Should full draft post be returned. */
|
|
4024
|
+
returnFullEntity?: boolean;
|
|
4025
|
+
}
|
|
4026
|
+
interface BulkRevertToUnpublishedResponse {
|
|
4027
|
+
/** Bulk action results. */
|
|
4028
|
+
results?: BulkDraftPostResult[];
|
|
4029
|
+
/** Bulk action metadata. */
|
|
4030
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4031
|
+
}
|
|
4032
|
+
interface BulkRejectDraftPostRequest {
|
|
3837
4033
|
/**
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
4034
|
+
* Source post IDs.
|
|
4035
|
+
* @minSize 1
|
|
4036
|
+
* @maxSize 100
|
|
4037
|
+
* @format GUID
|
|
3840
4038
|
*/
|
|
3841
|
-
|
|
3842
|
-
/**
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
|
|
4039
|
+
postIds?: string[];
|
|
4040
|
+
/** Should full draft post be returned. */
|
|
4041
|
+
returnFullEntity?: boolean;
|
|
4042
|
+
}
|
|
4043
|
+
interface BulkRejectDraftPostResponse {
|
|
4044
|
+
/** Bulk action results. */
|
|
4045
|
+
results?: BulkDraftPostResult[];
|
|
4046
|
+
/** Bulk action metadata. */
|
|
4047
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4048
|
+
}
|
|
4049
|
+
interface RevertToUnpublishedRequest {
|
|
3846
4050
|
/**
|
|
3847
|
-
*
|
|
3848
|
-
*
|
|
4051
|
+
* Source post ID.
|
|
4052
|
+
* @format GUID
|
|
3849
4053
|
*/
|
|
3850
|
-
|
|
3851
|
-
/** If present, indicates the action that triggered the event. */
|
|
3852
|
-
originatedFrom?: string | null;
|
|
4054
|
+
postId?: string;
|
|
3853
4055
|
/**
|
|
3854
|
-
*
|
|
3855
|
-
*
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
}
|
|
3859
|
-
/** @oneof */
|
|
3860
|
-
interface DomainEventBodyOneOf {
|
|
3861
|
-
createdEvent?: EntityCreatedEvent;
|
|
3862
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
3863
|
-
deletedEvent?: EntityDeletedEvent;
|
|
3864
|
-
actionEvent?: ActionEvent;
|
|
3865
|
-
}
|
|
3866
|
-
interface EntityCreatedEvent {
|
|
3867
|
-
entity?: string;
|
|
3868
|
-
}
|
|
3869
|
-
interface RestoreInfo {
|
|
3870
|
-
deletedDate?: Date | null;
|
|
3871
|
-
}
|
|
3872
|
-
interface EntityUpdatedEvent {
|
|
3873
|
-
/**
|
|
3874
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3875
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3876
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4056
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4057
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4058
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4059
|
+
* @maxSize 10
|
|
3877
4060
|
*/
|
|
3878
|
-
|
|
3879
|
-
}
|
|
3880
|
-
interface EntityDeletedEvent {
|
|
3881
|
-
/** Entity that was deleted. */
|
|
3882
|
-
deletedEntity?: string | null;
|
|
4061
|
+
fieldsets?: FieldWithLiterals[];
|
|
3883
4062
|
}
|
|
3884
|
-
interface
|
|
3885
|
-
|
|
4063
|
+
interface RevertToUnpublishedResponse {
|
|
4064
|
+
/** Updated post draft. */
|
|
4065
|
+
draftPost?: DraftPost;
|
|
3886
4066
|
}
|
|
3887
|
-
interface
|
|
4067
|
+
interface RejectDraftPostRequest {
|
|
3888
4068
|
/**
|
|
3889
|
-
*
|
|
4069
|
+
* Source post ID.
|
|
3890
4070
|
* @format GUID
|
|
3891
4071
|
*/
|
|
3892
|
-
|
|
4072
|
+
postId?: string;
|
|
3893
4073
|
/**
|
|
3894
|
-
*
|
|
3895
|
-
*
|
|
4074
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4075
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4076
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4077
|
+
* @maxSize 10
|
|
3896
4078
|
*/
|
|
3897
|
-
|
|
3898
|
-
/** The identification type and identity data. */
|
|
3899
|
-
identity?: IdentificationData;
|
|
3900
|
-
/** Stringify payload. */
|
|
3901
|
-
data?: string;
|
|
3902
|
-
/** Details related to the account */
|
|
3903
|
-
accountInfo?: AccountInfo;
|
|
4079
|
+
fieldsets?: FieldWithLiterals[];
|
|
3904
4080
|
}
|
|
3905
|
-
interface
|
|
3906
|
-
/**
|
|
3907
|
-
|
|
3908
|
-
* @format GUID
|
|
3909
|
-
*/
|
|
3910
|
-
anonymousVisitorId?: string;
|
|
3911
|
-
/**
|
|
3912
|
-
* ID of a site visitor that has logged in to the site.
|
|
3913
|
-
* @format GUID
|
|
3914
|
-
*/
|
|
3915
|
-
memberId?: string;
|
|
3916
|
-
/**
|
|
3917
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
3918
|
-
* @format GUID
|
|
3919
|
-
*/
|
|
3920
|
-
wixUserId?: string;
|
|
3921
|
-
/**
|
|
3922
|
-
* ID of an app.
|
|
3923
|
-
* @format GUID
|
|
3924
|
-
*/
|
|
3925
|
-
appId?: string;
|
|
3926
|
-
/** @readonly */
|
|
3927
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4081
|
+
interface RejectDraftPostResponse {
|
|
4082
|
+
/** Draft post. */
|
|
4083
|
+
draftPost?: DraftPost;
|
|
3928
4084
|
}
|
|
3929
|
-
|
|
3930
|
-
interface IdentificationDataIdOneOf {
|
|
3931
|
-
/**
|
|
3932
|
-
* ID of a site visitor that has not logged in to the site.
|
|
3933
|
-
* @format GUID
|
|
3934
|
-
*/
|
|
3935
|
-
anonymousVisitorId?: string;
|
|
4085
|
+
interface ApproveDraftPostRequest {
|
|
3936
4086
|
/**
|
|
3937
|
-
*
|
|
4087
|
+
* Source post ID.
|
|
3938
4088
|
* @format GUID
|
|
3939
4089
|
*/
|
|
3940
|
-
|
|
4090
|
+
postId?: string;
|
|
3941
4091
|
/**
|
|
3942
|
-
*
|
|
3943
|
-
* @
|
|
4092
|
+
* Scheduled publish date if should be not immediately published.
|
|
4093
|
+
* @maxLength 24
|
|
3944
4094
|
*/
|
|
3945
|
-
|
|
4095
|
+
scheduledPublishDate?: string | null;
|
|
3946
4096
|
/**
|
|
3947
|
-
*
|
|
3948
|
-
*
|
|
4097
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4098
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4099
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4100
|
+
* @maxSize 10
|
|
3949
4101
|
*/
|
|
3950
|
-
|
|
4102
|
+
fieldsets?: FieldWithLiterals[];
|
|
3951
4103
|
}
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
MEMBER = "MEMBER",
|
|
3956
|
-
WIX_USER = "WIX_USER",
|
|
3957
|
-
APP = "APP"
|
|
4104
|
+
interface ApproveDraftPostResponse {
|
|
4105
|
+
/** Updated post draft. */
|
|
4106
|
+
draftPost?: DraftPost;
|
|
3958
4107
|
}
|
|
3959
|
-
|
|
3960
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3961
|
-
interface AccountInfo {
|
|
3962
|
-
/**
|
|
3963
|
-
* ID of the Wix account associated with the event.
|
|
3964
|
-
* @format GUID
|
|
3965
|
-
*/
|
|
3966
|
-
accountId?: string | null;
|
|
3967
|
-
/**
|
|
3968
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3969
|
-
* @format GUID
|
|
3970
|
-
*/
|
|
3971
|
-
parentAccountId?: string | null;
|
|
4108
|
+
interface MarkPostAsInModerationRequest {
|
|
3972
4109
|
/**
|
|
3973
|
-
*
|
|
3974
|
-
* @
|
|
4110
|
+
* Source post ID.
|
|
4111
|
+
* @maxLength 38
|
|
3975
4112
|
*/
|
|
3976
|
-
|
|
3977
|
-
}
|
|
3978
|
-
interface GetDraftPostTotalsRequest {
|
|
4113
|
+
postId?: string;
|
|
3979
4114
|
/**
|
|
3980
|
-
*
|
|
3981
|
-
*
|
|
3982
|
-
*
|
|
4115
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4116
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4117
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3983
4118
|
* @maxSize 10
|
|
3984
4119
|
*/
|
|
3985
|
-
|
|
3986
|
-
/**
|
|
3987
|
-
* Optional language filter by provided language code. Useful in multilingual context.
|
|
3988
|
-
* @format LANGUAGE_TAG
|
|
3989
|
-
*/
|
|
3990
|
-
language?: string | null;
|
|
3991
|
-
}
|
|
3992
|
-
declare enum TotalDraftPostsGroupingField {
|
|
3993
|
-
/** Groups results by status. */
|
|
3994
|
-
STATUS = "STATUS",
|
|
3995
|
-
/** Groups results by language. */
|
|
3996
|
-
LANGUAGE = "LANGUAGE"
|
|
3997
|
-
}
|
|
3998
|
-
/** @enumType */
|
|
3999
|
-
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
4000
|
-
interface GetDraftPostTotalsResponse {
|
|
4001
|
-
/** Draft post totals. */
|
|
4002
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
4120
|
+
fieldsets?: FieldWithLiterals[];
|
|
4003
4121
|
}
|
|
4004
|
-
interface
|
|
4005
|
-
/**
|
|
4006
|
-
|
|
4007
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
4008
|
-
status?: StatusWithLiterals;
|
|
4009
|
-
/**
|
|
4010
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
4011
|
-
* @format LANGUAGE_TAG
|
|
4012
|
-
*/
|
|
4013
|
-
language?: string | null;
|
|
4122
|
+
interface MarkPostAsInModerationResponse {
|
|
4123
|
+
/** Updated post draft. */
|
|
4124
|
+
draftPost?: DraftPost;
|
|
4014
4125
|
}
|
|
4015
4126
|
interface TranslateDraftRequest {
|
|
4016
4127
|
/**
|
|
@@ -4085,117 +4196,6 @@ interface UpdateDraftPostLanguageResponse {
|
|
|
4085
4196
|
/** Draft post */
|
|
4086
4197
|
draftPost?: DraftPost;
|
|
4087
4198
|
}
|
|
4088
|
-
interface BulkRevertToUnpublishedRequest {
|
|
4089
|
-
/**
|
|
4090
|
-
* Source post IDs.
|
|
4091
|
-
* @minSize 1
|
|
4092
|
-
* @maxSize 100
|
|
4093
|
-
* @format GUID
|
|
4094
|
-
*/
|
|
4095
|
-
postIds?: string[];
|
|
4096
|
-
/** Should full draft post be returned. */
|
|
4097
|
-
returnFullEntity?: boolean;
|
|
4098
|
-
}
|
|
4099
|
-
interface BulkRevertToUnpublishedResponse {
|
|
4100
|
-
/** Bulk action results. */
|
|
4101
|
-
results?: BulkDraftPostResult[];
|
|
4102
|
-
/** Bulk action metadata. */
|
|
4103
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4104
|
-
}
|
|
4105
|
-
interface BulkRejectDraftPostRequest {
|
|
4106
|
-
/**
|
|
4107
|
-
* Source post IDs.
|
|
4108
|
-
* @minSize 1
|
|
4109
|
-
* @maxSize 100
|
|
4110
|
-
* @format GUID
|
|
4111
|
-
*/
|
|
4112
|
-
postIds?: string[];
|
|
4113
|
-
/** Should full draft post be returned. */
|
|
4114
|
-
returnFullEntity?: boolean;
|
|
4115
|
-
}
|
|
4116
|
-
interface BulkRejectDraftPostResponse {
|
|
4117
|
-
/** Bulk action results. */
|
|
4118
|
-
results?: BulkDraftPostResult[];
|
|
4119
|
-
/** Bulk action metadata. */
|
|
4120
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4121
|
-
}
|
|
4122
|
-
interface RevertToUnpublishedRequest {
|
|
4123
|
-
/**
|
|
4124
|
-
* Source post ID.
|
|
4125
|
-
* @format GUID
|
|
4126
|
-
*/
|
|
4127
|
-
postId?: string;
|
|
4128
|
-
/**
|
|
4129
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4130
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4131
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4132
|
-
* @maxSize 10
|
|
4133
|
-
*/
|
|
4134
|
-
fieldsets?: FieldWithLiterals[];
|
|
4135
|
-
}
|
|
4136
|
-
interface RevertToUnpublishedResponse {
|
|
4137
|
-
/** Updated post draft. */
|
|
4138
|
-
draftPost?: DraftPost;
|
|
4139
|
-
}
|
|
4140
|
-
interface RejectDraftPostRequest {
|
|
4141
|
-
/**
|
|
4142
|
-
* Source post ID.
|
|
4143
|
-
* @format GUID
|
|
4144
|
-
*/
|
|
4145
|
-
postId?: string;
|
|
4146
|
-
/**
|
|
4147
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4148
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4149
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4150
|
-
* @maxSize 10
|
|
4151
|
-
*/
|
|
4152
|
-
fieldsets?: FieldWithLiterals[];
|
|
4153
|
-
}
|
|
4154
|
-
interface RejectDraftPostResponse {
|
|
4155
|
-
/** Draft post. */
|
|
4156
|
-
draftPost?: DraftPost;
|
|
4157
|
-
}
|
|
4158
|
-
interface ApproveDraftPostRequest {
|
|
4159
|
-
/**
|
|
4160
|
-
* Source post ID.
|
|
4161
|
-
* @format GUID
|
|
4162
|
-
*/
|
|
4163
|
-
postId?: string;
|
|
4164
|
-
/**
|
|
4165
|
-
* Scheduled publish date if should be not immediately published.
|
|
4166
|
-
* @maxLength 24
|
|
4167
|
-
*/
|
|
4168
|
-
scheduledPublishDate?: string | null;
|
|
4169
|
-
/**
|
|
4170
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4171
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4172
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4173
|
-
* @maxSize 10
|
|
4174
|
-
*/
|
|
4175
|
-
fieldsets?: FieldWithLiterals[];
|
|
4176
|
-
}
|
|
4177
|
-
interface ApproveDraftPostResponse {
|
|
4178
|
-
/** Updated post draft. */
|
|
4179
|
-
draftPost?: DraftPost;
|
|
4180
|
-
}
|
|
4181
|
-
interface MarkPostAsInModerationRequest {
|
|
4182
|
-
/**
|
|
4183
|
-
* Source post ID.
|
|
4184
|
-
* @maxLength 38
|
|
4185
|
-
*/
|
|
4186
|
-
postId?: string;
|
|
4187
|
-
/**
|
|
4188
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4189
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4190
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4191
|
-
* @maxSize 10
|
|
4192
|
-
*/
|
|
4193
|
-
fieldsets?: FieldWithLiterals[];
|
|
4194
|
-
}
|
|
4195
|
-
interface MarkPostAsInModerationResponse {
|
|
4196
|
-
/** Updated post draft. */
|
|
4197
|
-
draftPost?: DraftPost;
|
|
4198
|
-
}
|
|
4199
4199
|
interface BaseEventMetadata {
|
|
4200
4200
|
/**
|
|
4201
4201
|
* App instance ID.
|
|
@@ -4342,7 +4342,7 @@ declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) => void |
|
|
|
4342
4342
|
* @applicableIdentity APP
|
|
4343
4343
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.CreateDraftPost
|
|
4344
4344
|
*/
|
|
4345
|
-
declare function createDraftPost(draftPost: NonNullablePaths<DraftPost, `title`,
|
|
4345
|
+
declare function createDraftPost(draftPost: NonNullablePaths<DraftPost, `title`, 0>, options?: CreateDraftPostOptions): Promise<NonNullablePaths<CreateDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`, 5>>;
|
|
4346
4346
|
interface CreateDraftPostOptions {
|
|
4347
4347
|
/**
|
|
4348
4348
|
* Whether the draft post should be published on creation.
|
|
@@ -4369,7 +4369,7 @@ interface CreateDraftPostOptions {
|
|
|
4369
4369
|
* @applicableIdentity APP
|
|
4370
4370
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkCreateDraftPosts
|
|
4371
4371
|
*/
|
|
4372
|
-
declare function bulkCreateDraftPosts(draftPosts: NonNullablePaths<DraftPost, `title`,
|
|
4372
|
+
declare function bulkCreateDraftPosts(draftPosts: NonNullablePaths<DraftPost, `title`, 0>[], options?: BulkCreateDraftPostsOptions): Promise<NonNullablePaths<BulkCreateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.title` | `results.${number}.item.minutesToRead` | `results.${number}.item.status` | `results.${number}.item.moderationDetails.submittedBy` | `results.${number}.item.moderationDetails.status` | `results.${number}.item.hasUnpublishedChanges` | `results.${number}.item.media.displayed` | `results.${number}.item.media.custom` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
4373
4373
|
interface BulkCreateDraftPostsOptions {
|
|
4374
4374
|
/** Whether the draft post should be published after creation. */
|
|
4375
4375
|
publish?: boolean;
|
|
@@ -4393,7 +4393,7 @@ interface BulkCreateDraftPostsOptions {
|
|
|
4393
4393
|
* @applicableIdentity APP
|
|
4394
4394
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkUpdateDraftPosts
|
|
4395
4395
|
*/
|
|
4396
|
-
declare function bulkUpdateDraftPosts(options?: NonNullablePaths<BulkUpdateDraftPostsOptions, `draftPosts.${number}.draftPost` | `draftPosts.${number}.draftPost._id`,
|
|
4396
|
+
declare function bulkUpdateDraftPosts(options?: NonNullablePaths<BulkUpdateDraftPostsOptions, `draftPosts.${number}.draftPost` | `draftPosts.${number}.draftPost._id`, 3>): Promise<NonNullablePaths<BulkUpdateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.title` | `results.${number}.item.minutesToRead` | `results.${number}.item.status` | `results.${number}.item.moderationDetails.submittedBy` | `results.${number}.item.moderationDetails.status` | `results.${number}.item.hasUnpublishedChanges` | `results.${number}.item.media.displayed` | `results.${number}.item.media.custom` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
4397
4397
|
interface BulkUpdateDraftPostsOptions {
|
|
4398
4398
|
/**
|
|
4399
4399
|
* Draft posts to update.
|
|
@@ -4432,7 +4432,7 @@ interface BulkUpdateDraftPostsOptions {
|
|
|
4432
4432
|
* @applicableIdentity APP
|
|
4433
4433
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDeletedDraftPosts
|
|
4434
4434
|
*/
|
|
4435
|
-
declare function listDeletedDraftPosts(options?: ListDeletedDraftPostsOptions): Promise<NonNullablePaths<ListDeletedDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom`,
|
|
4435
|
+
declare function listDeletedDraftPosts(options?: ListDeletedDraftPostsOptions): Promise<NonNullablePaths<ListDeletedDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom`, 4>>;
|
|
4436
4436
|
interface ListDeletedDraftPostsOptions {
|
|
4437
4437
|
/**
|
|
4438
4438
|
* Language filter.
|
|
@@ -4474,7 +4474,7 @@ interface ListDeletedDraftPostsOptions {
|
|
|
4474
4474
|
* @applicableIdentity APP
|
|
4475
4475
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDraftPost
|
|
4476
4476
|
*/
|
|
4477
|
-
declare function getDraftPost(draftPostId: string, options?: GetDraftPostOptions): Promise<NonNullablePaths<GetDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`,
|
|
4477
|
+
declare function getDraftPost(draftPostId: string, options?: GetDraftPostOptions): Promise<NonNullablePaths<GetDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`, 5>>;
|
|
4478
4478
|
interface GetDraftPostOptions {
|
|
4479
4479
|
/**
|
|
4480
4480
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
@@ -4496,7 +4496,7 @@ interface GetDraftPostOptions {
|
|
|
4496
4496
|
* @applicableIdentity APP
|
|
4497
4497
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.UpdateDraftPost
|
|
4498
4498
|
*/
|
|
4499
|
-
declare function updateDraftPost(_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise<NonNullablePaths<UpdateDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`,
|
|
4499
|
+
declare function updateDraftPost(_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise<NonNullablePaths<UpdateDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`, 5>>;
|
|
4500
4500
|
interface UpdateDraftPost {
|
|
4501
4501
|
/**
|
|
4502
4502
|
* Draft post ID.
|
|
@@ -4693,7 +4693,7 @@ declare function removeFromTrashBin(draftPostId: string): Promise<void>;
|
|
|
4693
4693
|
* @applicableIdentity APP
|
|
4694
4694
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkDeleteDraftPosts
|
|
4695
4695
|
*/
|
|
4696
|
-
declare function bulkDeleteDraftPosts(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` | `results.${number}.item._id` | `results.${number}.item.title` | `results.${number}.item.minutesToRead` | `results.${number}.item.status` | `results.${number}.item.moderationDetails.submittedBy` | `results.${number}.item.moderationDetails.status` | `results.${number}.item.hasUnpublishedChanges` | `results.${number}.item.media.displayed` | `results.${number}.item.media.custom` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
4696
|
+
declare function bulkDeleteDraftPosts(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` | `results.${number}.item._id` | `results.${number}.item.title` | `results.${number}.item.minutesToRead` | `results.${number}.item.status` | `results.${number}.item.moderationDetails.submittedBy` | `results.${number}.item.moderationDetails.status` | `results.${number}.item.hasUnpublishedChanges` | `results.${number}.item.media.displayed` | `results.${number}.item.media.custom` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
4697
4697
|
interface BulkDeleteDraftPostsOptions {
|
|
4698
4698
|
/** Should delete bypassing the trash-bin. */
|
|
4699
4699
|
permanent?: boolean;
|
|
@@ -4711,7 +4711,7 @@ interface BulkDeleteDraftPostsOptions {
|
|
|
4711
4711
|
* @applicableIdentity APP
|
|
4712
4712
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDraftPosts
|
|
4713
4713
|
*/
|
|
4714
|
-
declare function listDraftPosts(options?: ListDraftPostsOptions): Promise<NonNullablePaths<ListDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom` | `metaData.count` | `metaData.offset` | `metaData.total`,
|
|
4714
|
+
declare function listDraftPosts(options?: ListDraftPostsOptions): Promise<NonNullablePaths<ListDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom` | `metaData.count` | `metaData.offset` | `metaData.total`, 4>>;
|
|
4715
4715
|
interface ListDraftPostsOptions {
|
|
4716
4716
|
/**
|
|
4717
4717
|
* Draft post status filter.
|
|
@@ -4752,7 +4752,7 @@ interface ListDraftPostsOptions {
|
|
|
4752
4752
|
* @applicableIdentity APP
|
|
4753
4753
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDeletedDraftPost
|
|
4754
4754
|
*/
|
|
4755
|
-
declare function getDeletedDraftPost(draftPostId: string): Promise<NonNullablePaths<GetDeletedDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`,
|
|
4755
|
+
declare function getDeletedDraftPost(draftPostId: string): Promise<NonNullablePaths<GetDeletedDraftPostResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`, 5>>;
|
|
4756
4756
|
/**
|
|
4757
4757
|
* Restores a deleted draft post from the trash bin by the provided ID.
|
|
4758
4758
|
* @param draftPostId - Draft post ID.
|
|
@@ -4762,7 +4762,7 @@ declare function getDeletedDraftPost(draftPostId: string): Promise<NonNullablePa
|
|
|
4762
4762
|
* @applicableIdentity APP
|
|
4763
4763
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.RestoreFromTrashBin
|
|
4764
4764
|
*/
|
|
4765
|
-
declare function restoreFromTrashBin(draftPostId: string): Promise<NonNullablePaths<RestoreFromTrashBinResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`,
|
|
4765
|
+
declare function restoreFromTrashBin(draftPostId: string): Promise<NonNullablePaths<RestoreFromTrashBinResponse, `draftPost._id` | `draftPost.title` | `draftPost.categoryIds` | `draftPost.hashtags` | `draftPost.minutesToRead` | `draftPost.tagIds` | `draftPost.relatedPostIds` | `draftPost.pricingPlanIds` | `draftPost.status` | `draftPost.moderationDetails.submittedBy` | `draftPost.moderationDetails.status` | `draftPost.hasUnpublishedChanges` | `draftPost.seoData.tags` | `draftPost.seoData.tags.${number}.type` | `draftPost.seoData.tags.${number}.children` | `draftPost.seoData.tags.${number}.custom` | `draftPost.seoData.tags.${number}.disabled` | `draftPost.seoData.settings.preventAutoRedirect` | `draftPost.seoData.settings.keywords` | `draftPost.seoData.settings.keywords.${number}.term` | `draftPost.seoData.settings.keywords.${number}.isMain` | `draftPost.media.embedMedia.thumbnail.url` | `draftPost.media.embedMedia.thumbnail.width` | `draftPost.media.embedMedia.thumbnail.height` | `draftPost.media.embedMedia.video.url` | `draftPost.media.embedMedia.video.width` | `draftPost.media.embedMedia.video.height` | `draftPost.media.displayed` | `draftPost.media.custom`, 5>>;
|
|
4766
4766
|
/**
|
|
4767
4767
|
* Creates a query to retrieve a list of up to 100 draft posts.
|
|
4768
4768
|
*
|
|
@@ -4861,7 +4861,7 @@ interface DraftPostsQueryBuilder {
|
|
|
4861
4861
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.QueryDraftPosts
|
|
4862
4862
|
* @requiredField query
|
|
4863
4863
|
*/
|
|
4864
|
-
declare function typedQueryDraftPosts(query: DraftPostQuery, options?: QueryDraftPostsOptions): Promise<NonNullablePaths<QueryDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom`,
|
|
4864
|
+
declare function typedQueryDraftPosts(query: DraftPostQuery, options?: QueryDraftPostsOptions): Promise<NonNullablePaths<QueryDraftPostsResponse, `draftPosts` | `draftPosts.${number}._id` | `draftPosts.${number}.title` | `draftPosts.${number}.minutesToRead` | `draftPosts.${number}.status` | `draftPosts.${number}.moderationDetails.submittedBy` | `draftPosts.${number}.moderationDetails.status` | `draftPosts.${number}.hasUnpublishedChanges` | `draftPosts.${number}.seoData.settings.preventAutoRedirect` | `draftPosts.${number}.media.displayed` | `draftPosts.${number}.media.custom`, 4>>;
|
|
4865
4865
|
interface DraftPostQuerySpec extends QuerySpec {
|
|
4866
4866
|
paging: 'cursor';
|
|
4867
4867
|
wql: [
|
|
@@ -4990,6 +4990,6 @@ declare const utils: {
|
|
|
4990
4990
|
* @applicableIdentity APP
|
|
4991
4991
|
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.PublishDraftPost
|
|
4992
4992
|
*/
|
|
4993
|
-
declare function publishDraftPost(draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`,
|
|
4993
|
+
declare function publishDraftPost(draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`, 0>>;
|
|
4994
4994
|
|
|
4995
4995
|
export { type AccountInfo, type AccountInfoMetadata, Action, type ActionEvent, type ActionWithLiterals, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, AnimationType, type AnimationTypeWithLiterals, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type ApproveDraftPostRequest, type ApproveDraftPostResponse, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkActionMetadata, type BulkCreateDraftPostsOptions, type BulkCreateDraftPostsRequest, type BulkCreateDraftPostsResponse, type BulkDeleteDraftPostsOptions, type BulkDeleteDraftPostsRequest, type BulkDeleteDraftPostsResponse, type BulkDraftPostResult, type BulkRejectDraftPostRequest, type BulkRejectDraftPostResponse, type BulkRevertToUnpublishedRequest, type BulkRevertToUnpublishedResponse, type BulkUpdateDraftPostsOptions, type BulkUpdateDraftPostsRequest, type BulkUpdateDraftPostsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type CreateDraftPostOptions, type CreateDraftPostRequest, type CreateDraftPostResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteDraftPostOptions, type DeleteDraftPostRequest, type DeleteDraftPostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftCategoriesUpdated, type DraftCreatedEnvelope, type DraftDeletedEnvelope, type DraftPost, type DraftPostCount, type DraftPostOwnerChanged, type DraftPostQuery, type DraftPostQuerySpec, type DraftPostTranslation, type DraftPostsQueryBuilder, type DraftPostsQueryResult, type DraftTagsUpdated, type DraftUpdatedEnvelope, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetDeletedDraftPostRequest, type GetDeletedDraftPostResponse, type GetDraftPostCountsRequest, type GetDraftPostCountsResponse, type GetDraftPostOptions, type GetDraftPostRequest, type GetDraftPostResponse, type GetDraftPostTotalsRequest, type GetDraftPostTotalsResponse, GetDraftPostsSort, type GetDraftPostsSortWithLiterals, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, type InitialDraftPostsCopied, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type IsDraftPostAutoTranslatableRequest, type IsDraftPostAutoTranslatableResponse, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, type Keyword, LayerEffect, type LayerEffectWithLiterals, type Layers, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDeletedDraftPostsOptions, type ListDeletedDraftPostsRequest, type ListDeletedDraftPostsResponse, type ListDraftPostsOptions, type ListDraftPostsRequest, type ListDraftPostsResponse, type ListItemNodeData, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type MarkPostAsInModerationRequest, type MarkPostAsInModerationResponse, type MaskedDraftPosts, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type PointerEffect, PointerEffectType, type PointerEffectTypeWithLiterals, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type PricingData, type PublishDraftPostRequest, type PublishDraftPostResponse, type QueryDraftPostsOptions, type QueryDraftPostsRequest, type QueryDraftPostsResponse, type RejectDraftPostRequest, type RejectDraftPostResponse, type Rel, type RemoveFromTrashBinRequest, type RemoveFromTrashBinResponse, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreFromTrashBinRequest, type RestoreFromTrashBinResponse, type RestoreInfo, type RevertToUnpublishedRequest, type RevertToUnpublishedResponse, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type SectionDivider, type SeoSchema, type Settings, Shape, type ShapeData, type ShapeDataStyles, type ShapeWithLiterals, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, type TotalDraftPosts, TotalDraftPostsGroupingField, type TotalDraftPostsGroupingFieldWithLiterals, type TranslateDraftRequest, type TranslateDraftResponse, Type, type TypeWithLiterals, type UnpublishPostRequest, type UnpublishPostResponse, type UpdateDraftPost, type UpdateDraftPostContentRequest, type UpdateDraftPostContentResponse, type UpdateDraftPostLanguageRequest, type UpdateDraftPostLanguageResponse, type UpdateDraftPostOptions, type UpdateDraftPostRequest, type UpdateDraftPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, bulkCreateDraftPosts, bulkDeleteDraftPosts, bulkUpdateDraftPosts, createDraftPost, deleteDraftPost, getDeletedDraftPost, getDraftPost, listDeletedDraftPosts, listDraftPosts, onDraftCreated, onDraftDeleted, onDraftUpdated, publishDraftPost, queryDraftPosts, removeFromTrashBin, restoreFromTrashBin, typedQueryDraftPosts, updateDraftPost, utils };
|