@wix/auto_sdk_blog_draft-posts 1.0.117 → 1.0.119
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.js +18 -18
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +285 -283
- package/build/cjs/index.typings.js +18 -18
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +287 -285
- package/build/cjs/meta.js +18 -18
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +18 -18
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +285 -283
- package/build/es/index.typings.mjs +18 -18
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +287 -285
- package/build/es/meta.mjs +18 -18
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +314 -312
- package/build/internal/cjs/meta.d.ts +743 -741
- package/build/internal/es/index.typings.d.mts +314 -312
- package/build/internal/es/meta.d.mts +743 -741
- package/package.json +2 -2
|
@@ -993,6 +993,8 @@ interface TextStyle {
|
|
|
993
993
|
textAlignment?: TextAlignmentWithLiterals;
|
|
994
994
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
995
995
|
lineHeight?: string | null;
|
|
996
|
+
/** Font size of an empty block: it sizes the empty line, its list marker and the text typed into it. Ignored on a block with text, which is sized by its text's `FONT_SIZE` decorations. */
|
|
997
|
+
fontSize?: FontSizeData;
|
|
996
998
|
}
|
|
997
999
|
declare enum TextAlignment {
|
|
998
1000
|
/** browser default, eqivalent to `initial` */
|
|
@@ -1008,6 +1010,18 @@ declare enum TextAlignment {
|
|
|
1008
1010
|
}
|
|
1009
1011
|
/** @enumType */
|
|
1010
1012
|
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1013
|
+
interface FontSizeData {
|
|
1014
|
+
/** The units used for the font size. */
|
|
1015
|
+
unit?: FontTypeWithLiterals;
|
|
1016
|
+
/** Font size value. */
|
|
1017
|
+
value?: number | null;
|
|
1018
|
+
}
|
|
1019
|
+
declare enum FontType {
|
|
1020
|
+
PX = "PX",
|
|
1021
|
+
EM = "EM"
|
|
1022
|
+
}
|
|
1023
|
+
/** @enumType */
|
|
1024
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1011
1025
|
interface DividerData {
|
|
1012
1026
|
/** Styling for the divider's container. */
|
|
1013
1027
|
containerData?: PluginContainerData;
|
|
@@ -1872,18 +1886,6 @@ interface MentionData {
|
|
|
1872
1886
|
/** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
|
|
1873
1887
|
type?: string | null;
|
|
1874
1888
|
}
|
|
1875
|
-
interface FontSizeData {
|
|
1876
|
-
/** The units used for the font size. */
|
|
1877
|
-
unit?: FontTypeWithLiterals;
|
|
1878
|
-
/** Font size value. */
|
|
1879
|
-
value?: number | null;
|
|
1880
|
-
}
|
|
1881
|
-
declare enum FontType {
|
|
1882
|
-
PX = "PX",
|
|
1883
|
-
EM = "EM"
|
|
1884
|
-
}
|
|
1885
|
-
/** @enumType */
|
|
1886
|
-
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1887
1889
|
interface SpoilerData {
|
|
1888
1890
|
/** Spoiler ID. */
|
|
1889
1891
|
id?: string | null;
|
|
@@ -3414,10 +3416,6 @@ interface DraftPostTranslation {
|
|
|
3414
3416
|
/** Post URL. */
|
|
3415
3417
|
url?: string;
|
|
3416
3418
|
}
|
|
3417
|
-
interface InitialDraftPostsCopied {
|
|
3418
|
-
/** Number of draft posts copied. */
|
|
3419
|
-
count?: number;
|
|
3420
|
-
}
|
|
3421
3419
|
interface DraftCategoriesUpdated {
|
|
3422
3420
|
/**
|
|
3423
3421
|
* Draft post ID.
|
|
@@ -3456,6 +3454,200 @@ interface DraftTagsUpdated {
|
|
|
3456
3454
|
*/
|
|
3457
3455
|
previousTags?: string[];
|
|
3458
3456
|
}
|
|
3457
|
+
interface GetDraftPostTotalsRequest {
|
|
3458
|
+
/**
|
|
3459
|
+
* Group results by fields (defaults to grouping by status).
|
|
3460
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
3461
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
3462
|
+
* @maxSize 10
|
|
3463
|
+
*/
|
|
3464
|
+
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
3465
|
+
/**
|
|
3466
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
3467
|
+
* @format LANGUAGE_TAG
|
|
3468
|
+
*/
|
|
3469
|
+
language?: string | null;
|
|
3470
|
+
}
|
|
3471
|
+
declare enum TotalDraftPostsGroupingField {
|
|
3472
|
+
/** Groups results by status. */
|
|
3473
|
+
STATUS = "STATUS",
|
|
3474
|
+
/** Groups results by language. */
|
|
3475
|
+
LANGUAGE = "LANGUAGE"
|
|
3476
|
+
}
|
|
3477
|
+
/** @enumType */
|
|
3478
|
+
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
3479
|
+
interface GetDraftPostTotalsResponse {
|
|
3480
|
+
/** Draft post totals. */
|
|
3481
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
3482
|
+
}
|
|
3483
|
+
interface TotalDraftPosts {
|
|
3484
|
+
/** Draft post totals in that group. */
|
|
3485
|
+
total?: number;
|
|
3486
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
3487
|
+
status?: StatusWithLiterals;
|
|
3488
|
+
/**
|
|
3489
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
3490
|
+
* @format LANGUAGE_TAG
|
|
3491
|
+
*/
|
|
3492
|
+
language?: string | null;
|
|
3493
|
+
}
|
|
3494
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3495
|
+
createdEvent?: EntityCreatedEvent;
|
|
3496
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3497
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3498
|
+
actionEvent?: ActionEvent;
|
|
3499
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3500
|
+
_id?: string;
|
|
3501
|
+
/**
|
|
3502
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3503
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3504
|
+
*/
|
|
3505
|
+
entityFqdn?: string;
|
|
3506
|
+
/**
|
|
3507
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3508
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3509
|
+
*/
|
|
3510
|
+
slug?: string;
|
|
3511
|
+
/** ID of the entity associated with the event. */
|
|
3512
|
+
entityId?: string;
|
|
3513
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3514
|
+
eventTime?: Date | null;
|
|
3515
|
+
/**
|
|
3516
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3517
|
+
* (for example, GDPR).
|
|
3518
|
+
*/
|
|
3519
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3520
|
+
/** If present, indicates the action that triggered the event. */
|
|
3521
|
+
originatedFrom?: string | null;
|
|
3522
|
+
/**
|
|
3523
|
+
* 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.
|
|
3524
|
+
* 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.
|
|
3525
|
+
*/
|
|
3526
|
+
entityEventSequence?: string | null;
|
|
3527
|
+
}
|
|
3528
|
+
/** @oneof */
|
|
3529
|
+
interface DomainEventBodyOneOf {
|
|
3530
|
+
createdEvent?: EntityCreatedEvent;
|
|
3531
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3532
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3533
|
+
actionEvent?: ActionEvent;
|
|
3534
|
+
}
|
|
3535
|
+
interface EntityCreatedEvent {
|
|
3536
|
+
entity?: string;
|
|
3537
|
+
}
|
|
3538
|
+
interface RestoreInfo {
|
|
3539
|
+
deletedDate?: Date | null;
|
|
3540
|
+
}
|
|
3541
|
+
interface EntityUpdatedEvent {
|
|
3542
|
+
/**
|
|
3543
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3544
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3545
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3546
|
+
*/
|
|
3547
|
+
currentEntity?: string;
|
|
3548
|
+
}
|
|
3549
|
+
interface EntityDeletedEvent {
|
|
3550
|
+
/** Entity that was deleted. */
|
|
3551
|
+
deletedEntity?: string | null;
|
|
3552
|
+
}
|
|
3553
|
+
interface ActionEvent {
|
|
3554
|
+
body?: string;
|
|
3555
|
+
}
|
|
3556
|
+
interface MessageEnvelope {
|
|
3557
|
+
/**
|
|
3558
|
+
* App instance ID.
|
|
3559
|
+
* @format GUID
|
|
3560
|
+
*/
|
|
3561
|
+
instanceId?: string | null;
|
|
3562
|
+
/**
|
|
3563
|
+
* Event type.
|
|
3564
|
+
* @maxLength 150
|
|
3565
|
+
*/
|
|
3566
|
+
eventType?: string;
|
|
3567
|
+
/** The identification type and identity data. */
|
|
3568
|
+
identity?: IdentificationData;
|
|
3569
|
+
/** Stringify payload. */
|
|
3570
|
+
data?: string;
|
|
3571
|
+
/** Details related to the account */
|
|
3572
|
+
accountInfo?: AccountInfo;
|
|
3573
|
+
}
|
|
3574
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3575
|
+
/**
|
|
3576
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3577
|
+
* @format GUID
|
|
3578
|
+
*/
|
|
3579
|
+
anonymousVisitorId?: string;
|
|
3580
|
+
/**
|
|
3581
|
+
* ID of a site visitor that has logged in to the site.
|
|
3582
|
+
* @format GUID
|
|
3583
|
+
*/
|
|
3584
|
+
memberId?: string;
|
|
3585
|
+
/**
|
|
3586
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3587
|
+
* @format GUID
|
|
3588
|
+
*/
|
|
3589
|
+
wixUserId?: string;
|
|
3590
|
+
/**
|
|
3591
|
+
* ID of an app.
|
|
3592
|
+
* @format GUID
|
|
3593
|
+
*/
|
|
3594
|
+
appId?: string;
|
|
3595
|
+
/** @readonly */
|
|
3596
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3597
|
+
}
|
|
3598
|
+
/** @oneof */
|
|
3599
|
+
interface IdentificationDataIdOneOf {
|
|
3600
|
+
/**
|
|
3601
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3602
|
+
* @format GUID
|
|
3603
|
+
*/
|
|
3604
|
+
anonymousVisitorId?: string;
|
|
3605
|
+
/**
|
|
3606
|
+
* ID of a site visitor that has logged in to the site.
|
|
3607
|
+
* @format GUID
|
|
3608
|
+
*/
|
|
3609
|
+
memberId?: string;
|
|
3610
|
+
/**
|
|
3611
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3612
|
+
* @format GUID
|
|
3613
|
+
*/
|
|
3614
|
+
wixUserId?: string;
|
|
3615
|
+
/**
|
|
3616
|
+
* ID of an app.
|
|
3617
|
+
* @format GUID
|
|
3618
|
+
*/
|
|
3619
|
+
appId?: string;
|
|
3620
|
+
}
|
|
3621
|
+
declare enum WebhookIdentityType {
|
|
3622
|
+
UNKNOWN = "UNKNOWN",
|
|
3623
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3624
|
+
MEMBER = "MEMBER",
|
|
3625
|
+
WIX_USER = "WIX_USER",
|
|
3626
|
+
APP = "APP"
|
|
3627
|
+
}
|
|
3628
|
+
/** @enumType */
|
|
3629
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3630
|
+
interface AccountInfo {
|
|
3631
|
+
/**
|
|
3632
|
+
* ID of the Wix account associated with the event.
|
|
3633
|
+
* @format GUID
|
|
3634
|
+
*/
|
|
3635
|
+
accountId?: string | null;
|
|
3636
|
+
/**
|
|
3637
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3638
|
+
* @format GUID
|
|
3639
|
+
*/
|
|
3640
|
+
parentAccountId?: string | null;
|
|
3641
|
+
/**
|
|
3642
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3643
|
+
* @format GUID
|
|
3644
|
+
*/
|
|
3645
|
+
siteId?: string | null;
|
|
3646
|
+
}
|
|
3647
|
+
interface InitialDraftPostsCopied {
|
|
3648
|
+
/** Number of draft posts copied. */
|
|
3649
|
+
count?: number;
|
|
3650
|
+
}
|
|
3459
3651
|
interface CreateDraftPostRequest {
|
|
3460
3652
|
/** Draft post to create. */
|
|
3461
3653
|
draftPost: DraftPost;
|
|
@@ -4105,195 +4297,152 @@ interface DraftPostCount {
|
|
|
4105
4297
|
/** Number of posts. */
|
|
4106
4298
|
postCount?: number;
|
|
4107
4299
|
}
|
|
4108
|
-
interface
|
|
4109
|
-
createdEvent?: EntityCreatedEvent;
|
|
4110
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4111
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4112
|
-
actionEvent?: ActionEvent;
|
|
4113
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4114
|
-
_id?: string;
|
|
4300
|
+
interface BulkRevertToUnpublishedRequest {
|
|
4115
4301
|
/**
|
|
4116
|
-
*
|
|
4117
|
-
*
|
|
4302
|
+
* Source post IDs.
|
|
4303
|
+
* @minSize 1
|
|
4304
|
+
* @maxSize 100
|
|
4305
|
+
* @format GUID
|
|
4118
4306
|
*/
|
|
4119
|
-
|
|
4307
|
+
postIds?: string[];
|
|
4308
|
+
/** Should full draft post be returned. */
|
|
4309
|
+
returnFullEntity?: boolean;
|
|
4310
|
+
}
|
|
4311
|
+
interface BulkRevertToUnpublishedResponse {
|
|
4312
|
+
/** Bulk action results. */
|
|
4313
|
+
results?: BulkDraftPostResult[];
|
|
4314
|
+
/** Bulk action metadata. */
|
|
4315
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4316
|
+
}
|
|
4317
|
+
interface BulkRejectDraftPostRequest {
|
|
4120
4318
|
/**
|
|
4121
|
-
*
|
|
4122
|
-
*
|
|
4319
|
+
* Source post IDs.
|
|
4320
|
+
* @minSize 1
|
|
4321
|
+
* @maxSize 100
|
|
4322
|
+
* @format GUID
|
|
4123
4323
|
*/
|
|
4124
|
-
|
|
4125
|
-
/**
|
|
4126
|
-
|
|
4127
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4128
|
-
eventTime?: Date | null;
|
|
4129
|
-
/**
|
|
4130
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
4131
|
-
* (for example, GDPR).
|
|
4132
|
-
*/
|
|
4133
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
4134
|
-
/** If present, indicates the action that triggered the event. */
|
|
4135
|
-
originatedFrom?: string | null;
|
|
4136
|
-
/**
|
|
4137
|
-
* 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.
|
|
4138
|
-
* 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.
|
|
4139
|
-
*/
|
|
4140
|
-
entityEventSequence?: string | null;
|
|
4141
|
-
}
|
|
4142
|
-
/** @oneof */
|
|
4143
|
-
interface DomainEventBodyOneOf {
|
|
4144
|
-
createdEvent?: EntityCreatedEvent;
|
|
4145
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4146
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4147
|
-
actionEvent?: ActionEvent;
|
|
4148
|
-
}
|
|
4149
|
-
interface EntityCreatedEvent {
|
|
4150
|
-
entity?: string;
|
|
4151
|
-
}
|
|
4152
|
-
interface RestoreInfo {
|
|
4153
|
-
deletedDate?: Date | null;
|
|
4154
|
-
}
|
|
4155
|
-
interface EntityUpdatedEvent {
|
|
4156
|
-
/**
|
|
4157
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4158
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4159
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4160
|
-
*/
|
|
4161
|
-
currentEntity?: string;
|
|
4162
|
-
}
|
|
4163
|
-
interface EntityDeletedEvent {
|
|
4164
|
-
/** Entity that was deleted. */
|
|
4165
|
-
deletedEntity?: string | null;
|
|
4324
|
+
postIds?: string[];
|
|
4325
|
+
/** Should full draft post be returned. */
|
|
4326
|
+
returnFullEntity?: boolean;
|
|
4166
4327
|
}
|
|
4167
|
-
interface
|
|
4168
|
-
|
|
4328
|
+
interface BulkRejectDraftPostResponse {
|
|
4329
|
+
/** Bulk action results. */
|
|
4330
|
+
results?: BulkDraftPostResult[];
|
|
4331
|
+
/** Bulk action metadata. */
|
|
4332
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4169
4333
|
}
|
|
4170
|
-
interface
|
|
4334
|
+
interface RevertToUnpublishedRequest {
|
|
4171
4335
|
/**
|
|
4172
|
-
*
|
|
4336
|
+
* Source post ID.
|
|
4173
4337
|
* @format GUID
|
|
4174
4338
|
*/
|
|
4175
|
-
|
|
4339
|
+
postId?: string;
|
|
4176
4340
|
/**
|
|
4177
|
-
*
|
|
4178
|
-
* @
|
|
4341
|
+
* List of draft post fields to be included in the response.
|
|
4342
|
+
* @internal
|
|
4343
|
+
* @maxSize 10
|
|
4344
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4345
|
+
* @replacedBy fieldsets
|
|
4346
|
+
* @targetRemovalDate 2024-06-30
|
|
4179
4347
|
*/
|
|
4180
|
-
|
|
4181
|
-
/** The identification type and identity data. */
|
|
4182
|
-
identity?: IdentificationData;
|
|
4183
|
-
/** Stringify payload. */
|
|
4184
|
-
data?: string;
|
|
4185
|
-
/** Details related to the account */
|
|
4186
|
-
accountInfo?: AccountInfo;
|
|
4187
|
-
}
|
|
4188
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4348
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4189
4349
|
/**
|
|
4190
|
-
*
|
|
4191
|
-
*
|
|
4350
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4351
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4352
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4353
|
+
* @maxSize 10
|
|
4192
4354
|
*/
|
|
4193
|
-
|
|
4355
|
+
fieldsets?: FieldWithLiterals[];
|
|
4356
|
+
}
|
|
4357
|
+
interface RevertToUnpublishedResponse {
|
|
4358
|
+
/** Updated post draft. */
|
|
4359
|
+
draftPost?: DraftPost;
|
|
4360
|
+
}
|
|
4361
|
+
interface RejectDraftPostRequest {
|
|
4194
4362
|
/**
|
|
4195
|
-
*
|
|
4363
|
+
* Source post ID.
|
|
4196
4364
|
* @format GUID
|
|
4197
4365
|
*/
|
|
4198
|
-
|
|
4366
|
+
postId?: string;
|
|
4199
4367
|
/**
|
|
4200
|
-
*
|
|
4201
|
-
* @
|
|
4368
|
+
* List of draft post fields to be included in the response.
|
|
4369
|
+
* @internal
|
|
4370
|
+
* @maxSize 10
|
|
4371
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4372
|
+
* @replacedBy fieldsets
|
|
4373
|
+
* @targetRemovalDate 2024-06-30
|
|
4202
4374
|
*/
|
|
4203
|
-
|
|
4375
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4204
4376
|
/**
|
|
4205
|
-
*
|
|
4206
|
-
*
|
|
4377
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4378
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4379
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4380
|
+
* @maxSize 10
|
|
4207
4381
|
*/
|
|
4208
|
-
|
|
4209
|
-
/** @readonly */
|
|
4210
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4382
|
+
fieldsets?: FieldWithLiterals[];
|
|
4211
4383
|
}
|
|
4212
|
-
|
|
4213
|
-
|
|
4384
|
+
interface RejectDraftPostResponse {
|
|
4385
|
+
/** Draft post. */
|
|
4386
|
+
draftPost?: DraftPost;
|
|
4387
|
+
}
|
|
4388
|
+
interface ApproveDraftPostRequest {
|
|
4214
4389
|
/**
|
|
4215
|
-
*
|
|
4390
|
+
* Source post ID.
|
|
4216
4391
|
* @format GUID
|
|
4217
4392
|
*/
|
|
4218
|
-
|
|
4393
|
+
postId?: string;
|
|
4219
4394
|
/**
|
|
4220
|
-
*
|
|
4221
|
-
* @
|
|
4395
|
+
* Scheduled publish date if should be not immediately published.
|
|
4396
|
+
* @maxLength 24
|
|
4222
4397
|
*/
|
|
4223
|
-
|
|
4398
|
+
scheduledPublishDate?: string | null;
|
|
4224
4399
|
/**
|
|
4225
|
-
*
|
|
4226
|
-
* @
|
|
4400
|
+
* List of draft post fields to be included in the response.
|
|
4401
|
+
* @internal
|
|
4402
|
+
* @maxSize 10
|
|
4403
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4404
|
+
* @replacedBy fieldsets
|
|
4405
|
+
* @targetRemovalDate 2024-06-30
|
|
4227
4406
|
*/
|
|
4228
|
-
|
|
4407
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4229
4408
|
/**
|
|
4230
|
-
*
|
|
4231
|
-
*
|
|
4409
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4410
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4411
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4412
|
+
* @maxSize 10
|
|
4232
4413
|
*/
|
|
4233
|
-
|
|
4414
|
+
fieldsets?: FieldWithLiterals[];
|
|
4234
4415
|
}
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
MEMBER = "MEMBER",
|
|
4239
|
-
WIX_USER = "WIX_USER",
|
|
4240
|
-
APP = "APP"
|
|
4416
|
+
interface ApproveDraftPostResponse {
|
|
4417
|
+
/** Updated post draft. */
|
|
4418
|
+
draftPost?: DraftPost;
|
|
4241
4419
|
}
|
|
4242
|
-
|
|
4243
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4244
|
-
interface AccountInfo {
|
|
4245
|
-
/**
|
|
4246
|
-
* ID of the Wix account associated with the event.
|
|
4247
|
-
* @format GUID
|
|
4248
|
-
*/
|
|
4249
|
-
accountId?: string | null;
|
|
4250
|
-
/**
|
|
4251
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
4252
|
-
* @format GUID
|
|
4253
|
-
*/
|
|
4254
|
-
parentAccountId?: string | null;
|
|
4420
|
+
interface MarkPostAsInModerationRequest {
|
|
4255
4421
|
/**
|
|
4256
|
-
*
|
|
4257
|
-
* @
|
|
4422
|
+
* Source post ID.
|
|
4423
|
+
* @maxLength 38
|
|
4258
4424
|
*/
|
|
4259
|
-
|
|
4260
|
-
}
|
|
4261
|
-
interface GetDraftPostTotalsRequest {
|
|
4425
|
+
postId?: string;
|
|
4262
4426
|
/**
|
|
4263
|
-
*
|
|
4264
|
-
*
|
|
4265
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
4427
|
+
* List of draft post fields to be included in the response.
|
|
4428
|
+
* @internal
|
|
4266
4429
|
* @maxSize 10
|
|
4430
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4431
|
+
* @replacedBy fieldsets
|
|
4432
|
+
* @targetRemovalDate 2024-06-30
|
|
4267
4433
|
*/
|
|
4268
|
-
|
|
4434
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4269
4435
|
/**
|
|
4270
|
-
*
|
|
4271
|
-
*
|
|
4436
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4437
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4438
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4439
|
+
* @maxSize 10
|
|
4272
4440
|
*/
|
|
4273
|
-
|
|
4274
|
-
}
|
|
4275
|
-
declare enum TotalDraftPostsGroupingField {
|
|
4276
|
-
/** Groups results by status. */
|
|
4277
|
-
STATUS = "STATUS",
|
|
4278
|
-
/** Groups results by language. */
|
|
4279
|
-
LANGUAGE = "LANGUAGE"
|
|
4280
|
-
}
|
|
4281
|
-
/** @enumType */
|
|
4282
|
-
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
4283
|
-
interface GetDraftPostTotalsResponse {
|
|
4284
|
-
/** Draft post totals. */
|
|
4285
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
4441
|
+
fieldsets?: FieldWithLiterals[];
|
|
4286
4442
|
}
|
|
4287
|
-
interface
|
|
4288
|
-
/**
|
|
4289
|
-
|
|
4290
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
4291
|
-
status?: StatusWithLiterals;
|
|
4292
|
-
/**
|
|
4293
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
4294
|
-
* @format LANGUAGE_TAG
|
|
4295
|
-
*/
|
|
4296
|
-
language?: string | null;
|
|
4443
|
+
interface MarkPostAsInModerationResponse {
|
|
4444
|
+
/** Updated post draft. */
|
|
4445
|
+
draftPost?: DraftPost;
|
|
4297
4446
|
}
|
|
4298
4447
|
interface TranslateDraftRequest {
|
|
4299
4448
|
/**
|
|
@@ -4387,153 +4536,6 @@ interface UpdateDraftPostLanguageResponse {
|
|
|
4387
4536
|
/** Updated draft post. */
|
|
4388
4537
|
draftPost?: DraftPost;
|
|
4389
4538
|
}
|
|
4390
|
-
interface BulkRevertToUnpublishedRequest {
|
|
4391
|
-
/**
|
|
4392
|
-
* Source post IDs.
|
|
4393
|
-
* @minSize 1
|
|
4394
|
-
* @maxSize 100
|
|
4395
|
-
* @format GUID
|
|
4396
|
-
*/
|
|
4397
|
-
postIds?: string[];
|
|
4398
|
-
/** Should full draft post be returned. */
|
|
4399
|
-
returnFullEntity?: boolean;
|
|
4400
|
-
}
|
|
4401
|
-
interface BulkRevertToUnpublishedResponse {
|
|
4402
|
-
/** Bulk action results. */
|
|
4403
|
-
results?: BulkDraftPostResult[];
|
|
4404
|
-
/** Bulk action metadata. */
|
|
4405
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4406
|
-
}
|
|
4407
|
-
interface BulkRejectDraftPostRequest {
|
|
4408
|
-
/**
|
|
4409
|
-
* Source post IDs.
|
|
4410
|
-
* @minSize 1
|
|
4411
|
-
* @maxSize 100
|
|
4412
|
-
* @format GUID
|
|
4413
|
-
*/
|
|
4414
|
-
postIds?: string[];
|
|
4415
|
-
/** Should full draft post be returned. */
|
|
4416
|
-
returnFullEntity?: boolean;
|
|
4417
|
-
}
|
|
4418
|
-
interface BulkRejectDraftPostResponse {
|
|
4419
|
-
/** Bulk action results. */
|
|
4420
|
-
results?: BulkDraftPostResult[];
|
|
4421
|
-
/** Bulk action metadata. */
|
|
4422
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4423
|
-
}
|
|
4424
|
-
interface RevertToUnpublishedRequest {
|
|
4425
|
-
/**
|
|
4426
|
-
* Source post ID.
|
|
4427
|
-
* @format GUID
|
|
4428
|
-
*/
|
|
4429
|
-
postId?: string;
|
|
4430
|
-
/**
|
|
4431
|
-
* List of draft post fields to be included in the response.
|
|
4432
|
-
* @internal
|
|
4433
|
-
* @maxSize 10
|
|
4434
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4435
|
-
* @replacedBy fieldsets
|
|
4436
|
-
* @targetRemovalDate 2024-06-30
|
|
4437
|
-
*/
|
|
4438
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4439
|
-
/**
|
|
4440
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4441
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4442
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4443
|
-
* @maxSize 10
|
|
4444
|
-
*/
|
|
4445
|
-
fieldsets?: FieldWithLiterals[];
|
|
4446
|
-
}
|
|
4447
|
-
interface RevertToUnpublishedResponse {
|
|
4448
|
-
/** Updated post draft. */
|
|
4449
|
-
draftPost?: DraftPost;
|
|
4450
|
-
}
|
|
4451
|
-
interface RejectDraftPostRequest {
|
|
4452
|
-
/**
|
|
4453
|
-
* Source post ID.
|
|
4454
|
-
* @format GUID
|
|
4455
|
-
*/
|
|
4456
|
-
postId?: string;
|
|
4457
|
-
/**
|
|
4458
|
-
* List of draft post fields to be included in the response.
|
|
4459
|
-
* @internal
|
|
4460
|
-
* @maxSize 10
|
|
4461
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4462
|
-
* @replacedBy fieldsets
|
|
4463
|
-
* @targetRemovalDate 2024-06-30
|
|
4464
|
-
*/
|
|
4465
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4466
|
-
/**
|
|
4467
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4468
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4469
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4470
|
-
* @maxSize 10
|
|
4471
|
-
*/
|
|
4472
|
-
fieldsets?: FieldWithLiterals[];
|
|
4473
|
-
}
|
|
4474
|
-
interface RejectDraftPostResponse {
|
|
4475
|
-
/** Draft post. */
|
|
4476
|
-
draftPost?: DraftPost;
|
|
4477
|
-
}
|
|
4478
|
-
interface ApproveDraftPostRequest {
|
|
4479
|
-
/**
|
|
4480
|
-
* Source post ID.
|
|
4481
|
-
* @format GUID
|
|
4482
|
-
*/
|
|
4483
|
-
postId?: string;
|
|
4484
|
-
/**
|
|
4485
|
-
* Scheduled publish date if should be not immediately published.
|
|
4486
|
-
* @maxLength 24
|
|
4487
|
-
*/
|
|
4488
|
-
scheduledPublishDate?: string | null;
|
|
4489
|
-
/**
|
|
4490
|
-
* List of draft post fields to be included in the response.
|
|
4491
|
-
* @internal
|
|
4492
|
-
* @maxSize 10
|
|
4493
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4494
|
-
* @replacedBy fieldsets
|
|
4495
|
-
* @targetRemovalDate 2024-06-30
|
|
4496
|
-
*/
|
|
4497
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4498
|
-
/**
|
|
4499
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4500
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4501
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4502
|
-
* @maxSize 10
|
|
4503
|
-
*/
|
|
4504
|
-
fieldsets?: FieldWithLiterals[];
|
|
4505
|
-
}
|
|
4506
|
-
interface ApproveDraftPostResponse {
|
|
4507
|
-
/** Updated post draft. */
|
|
4508
|
-
draftPost?: DraftPost;
|
|
4509
|
-
}
|
|
4510
|
-
interface MarkPostAsInModerationRequest {
|
|
4511
|
-
/**
|
|
4512
|
-
* Source post ID.
|
|
4513
|
-
* @maxLength 38
|
|
4514
|
-
*/
|
|
4515
|
-
postId?: string;
|
|
4516
|
-
/**
|
|
4517
|
-
* List of draft post fields to be included in the response.
|
|
4518
|
-
* @internal
|
|
4519
|
-
* @maxSize 10
|
|
4520
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4521
|
-
* @replacedBy fieldsets
|
|
4522
|
-
* @targetRemovalDate 2024-06-30
|
|
4523
|
-
*/
|
|
4524
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4525
|
-
/**
|
|
4526
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4527
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4528
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4529
|
-
* @maxSize 10
|
|
4530
|
-
*/
|
|
4531
|
-
fieldsets?: FieldWithLiterals[];
|
|
4532
|
-
}
|
|
4533
|
-
interface MarkPostAsInModerationResponse {
|
|
4534
|
-
/** Updated post draft. */
|
|
4535
|
-
draftPost?: DraftPost;
|
|
4536
|
-
}
|
|
4537
4539
|
interface BaseEventMetadata {
|
|
4538
4540
|
/**
|
|
4539
4541
|
* App instance ID.
|