@wix/auto_sdk_blog_draft-posts 1.0.120 → 1.0.122
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 +19 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +272 -272
- package/build/cjs/index.typings.js +18 -13
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +274 -274
- package/build/cjs/meta.js +18 -13
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +19 -13
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +272 -272
- package/build/es/index.typings.mjs +18 -13
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +274 -274
- package/build/es/meta.mjs +18 -13
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +313 -301
- package/build/internal/cjs/meta.d.ts +337 -331
- package/build/internal/es/index.typings.d.mts +313 -301
- package/build/internal/es/meta.d.mts +337 -331
- package/package.json +2 -2
|
@@ -196,6 +196,12 @@ interface DraftPost {
|
|
|
196
196
|
* @format GUID
|
|
197
197
|
*/
|
|
198
198
|
originPostInstanceId?: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* Date the published post is automatically unpublished and reverted to a draft.
|
|
201
|
+
* Must be in the future, at most one year ahead, and later than `scheduled_publish_date` when the draft post is scheduled.
|
|
202
|
+
* @internal
|
|
203
|
+
*/
|
|
204
|
+
expirationDate?: Date | null;
|
|
199
205
|
/**
|
|
200
206
|
* Reserved for internal use.
|
|
201
207
|
* @internal
|
|
@@ -3477,10 +3483,6 @@ interface DraftPostTranslation {
|
|
|
3477
3483
|
/** Post URL. */
|
|
3478
3484
|
url?: string;
|
|
3479
3485
|
}
|
|
3480
|
-
interface InitialDraftPostsCopied {
|
|
3481
|
-
/** Number of draft posts copied. */
|
|
3482
|
-
count?: number;
|
|
3483
|
-
}
|
|
3484
3486
|
interface DraftCategoriesUpdated {
|
|
3485
3487
|
/**
|
|
3486
3488
|
* Draft post ID.
|
|
@@ -3519,6 +3521,200 @@ interface DraftTagsUpdated {
|
|
|
3519
3521
|
*/
|
|
3520
3522
|
previousTags?: string[];
|
|
3521
3523
|
}
|
|
3524
|
+
interface GetDraftPostTotalsRequest {
|
|
3525
|
+
/**
|
|
3526
|
+
* Group results by fields (defaults to grouping by status).
|
|
3527
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
3528
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
3529
|
+
* @maxSize 10
|
|
3530
|
+
*/
|
|
3531
|
+
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
3532
|
+
/**
|
|
3533
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
3534
|
+
* @format LANGUAGE_TAG
|
|
3535
|
+
*/
|
|
3536
|
+
language?: string | null;
|
|
3537
|
+
}
|
|
3538
|
+
declare enum TotalDraftPostsGroupingField {
|
|
3539
|
+
/** Groups results by status. */
|
|
3540
|
+
STATUS = "STATUS",
|
|
3541
|
+
/** Groups results by language. */
|
|
3542
|
+
LANGUAGE = "LANGUAGE"
|
|
3543
|
+
}
|
|
3544
|
+
/** @enumType */
|
|
3545
|
+
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
3546
|
+
interface GetDraftPostTotalsResponse {
|
|
3547
|
+
/** Draft post totals. */
|
|
3548
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
3549
|
+
}
|
|
3550
|
+
interface TotalDraftPosts {
|
|
3551
|
+
/** Draft post totals in that group. */
|
|
3552
|
+
total?: number;
|
|
3553
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
3554
|
+
status?: StatusWithLiterals;
|
|
3555
|
+
/**
|
|
3556
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
3557
|
+
* @format LANGUAGE_TAG
|
|
3558
|
+
*/
|
|
3559
|
+
language?: string | null;
|
|
3560
|
+
}
|
|
3561
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3562
|
+
createdEvent?: EntityCreatedEvent;
|
|
3563
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3564
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3565
|
+
actionEvent?: ActionEvent;
|
|
3566
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3567
|
+
_id?: string;
|
|
3568
|
+
/**
|
|
3569
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3570
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3571
|
+
*/
|
|
3572
|
+
entityFqdn?: string;
|
|
3573
|
+
/**
|
|
3574
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3575
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3576
|
+
*/
|
|
3577
|
+
slug?: string;
|
|
3578
|
+
/** ID of the entity associated with the event. */
|
|
3579
|
+
entityId?: string;
|
|
3580
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3581
|
+
eventTime?: Date | null;
|
|
3582
|
+
/**
|
|
3583
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3584
|
+
* (for example, GDPR).
|
|
3585
|
+
*/
|
|
3586
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3587
|
+
/** If present, indicates the action that triggered the event. */
|
|
3588
|
+
originatedFrom?: string | null;
|
|
3589
|
+
/**
|
|
3590
|
+
* 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.
|
|
3591
|
+
* 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.
|
|
3592
|
+
*/
|
|
3593
|
+
entityEventSequence?: string | null;
|
|
3594
|
+
}
|
|
3595
|
+
/** @oneof */
|
|
3596
|
+
interface DomainEventBodyOneOf {
|
|
3597
|
+
createdEvent?: EntityCreatedEvent;
|
|
3598
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3599
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3600
|
+
actionEvent?: ActionEvent;
|
|
3601
|
+
}
|
|
3602
|
+
interface EntityCreatedEvent {
|
|
3603
|
+
entity?: string;
|
|
3604
|
+
}
|
|
3605
|
+
interface RestoreInfo {
|
|
3606
|
+
deletedDate?: Date | null;
|
|
3607
|
+
}
|
|
3608
|
+
interface EntityUpdatedEvent {
|
|
3609
|
+
/**
|
|
3610
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3611
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3612
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3613
|
+
*/
|
|
3614
|
+
currentEntity?: string;
|
|
3615
|
+
}
|
|
3616
|
+
interface EntityDeletedEvent {
|
|
3617
|
+
/** Entity that was deleted. */
|
|
3618
|
+
deletedEntity?: string | null;
|
|
3619
|
+
}
|
|
3620
|
+
interface ActionEvent {
|
|
3621
|
+
body?: string;
|
|
3622
|
+
}
|
|
3623
|
+
interface MessageEnvelope {
|
|
3624
|
+
/**
|
|
3625
|
+
* App instance ID.
|
|
3626
|
+
* @format GUID
|
|
3627
|
+
*/
|
|
3628
|
+
instanceId?: string | null;
|
|
3629
|
+
/**
|
|
3630
|
+
* Event type.
|
|
3631
|
+
* @maxLength 150
|
|
3632
|
+
*/
|
|
3633
|
+
eventType?: string;
|
|
3634
|
+
/** The identification type and identity data. */
|
|
3635
|
+
identity?: IdentificationData;
|
|
3636
|
+
/** Stringify payload. */
|
|
3637
|
+
data?: string;
|
|
3638
|
+
/** Details related to the account */
|
|
3639
|
+
accountInfo?: AccountInfo;
|
|
3640
|
+
}
|
|
3641
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3642
|
+
/**
|
|
3643
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3644
|
+
* @format GUID
|
|
3645
|
+
*/
|
|
3646
|
+
anonymousVisitorId?: string;
|
|
3647
|
+
/**
|
|
3648
|
+
* ID of a site visitor that has logged in to the site.
|
|
3649
|
+
* @format GUID
|
|
3650
|
+
*/
|
|
3651
|
+
memberId?: string;
|
|
3652
|
+
/**
|
|
3653
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3654
|
+
* @format GUID
|
|
3655
|
+
*/
|
|
3656
|
+
wixUserId?: string;
|
|
3657
|
+
/**
|
|
3658
|
+
* ID of an app.
|
|
3659
|
+
* @format GUID
|
|
3660
|
+
*/
|
|
3661
|
+
appId?: string;
|
|
3662
|
+
/** @readonly */
|
|
3663
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3664
|
+
}
|
|
3665
|
+
/** @oneof */
|
|
3666
|
+
interface IdentificationDataIdOneOf {
|
|
3667
|
+
/**
|
|
3668
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3669
|
+
* @format GUID
|
|
3670
|
+
*/
|
|
3671
|
+
anonymousVisitorId?: string;
|
|
3672
|
+
/**
|
|
3673
|
+
* ID of a site visitor that has logged in to the site.
|
|
3674
|
+
* @format GUID
|
|
3675
|
+
*/
|
|
3676
|
+
memberId?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3679
|
+
* @format GUID
|
|
3680
|
+
*/
|
|
3681
|
+
wixUserId?: string;
|
|
3682
|
+
/**
|
|
3683
|
+
* ID of an app.
|
|
3684
|
+
* @format GUID
|
|
3685
|
+
*/
|
|
3686
|
+
appId?: string;
|
|
3687
|
+
}
|
|
3688
|
+
declare enum WebhookIdentityType {
|
|
3689
|
+
UNKNOWN = "UNKNOWN",
|
|
3690
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3691
|
+
MEMBER = "MEMBER",
|
|
3692
|
+
WIX_USER = "WIX_USER",
|
|
3693
|
+
APP = "APP"
|
|
3694
|
+
}
|
|
3695
|
+
/** @enumType */
|
|
3696
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3697
|
+
interface AccountInfo {
|
|
3698
|
+
/**
|
|
3699
|
+
* ID of the Wix account associated with the event.
|
|
3700
|
+
* @format GUID
|
|
3701
|
+
*/
|
|
3702
|
+
accountId?: string | null;
|
|
3703
|
+
/**
|
|
3704
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3705
|
+
* @format GUID
|
|
3706
|
+
*/
|
|
3707
|
+
parentAccountId?: string | null;
|
|
3708
|
+
/**
|
|
3709
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3710
|
+
* @format GUID
|
|
3711
|
+
*/
|
|
3712
|
+
siteId?: string | null;
|
|
3713
|
+
}
|
|
3714
|
+
interface InitialDraftPostsCopied {
|
|
3715
|
+
/** Number of draft posts copied. */
|
|
3716
|
+
count?: number;
|
|
3717
|
+
}
|
|
3522
3718
|
interface CreateDraftPostRequest {
|
|
3523
3719
|
/** Draft post to create. */
|
|
3524
3720
|
draftPost: DraftPost;
|
|
@@ -4168,195 +4364,152 @@ interface DraftPostCount {
|
|
|
4168
4364
|
/** Number of posts. */
|
|
4169
4365
|
postCount?: number;
|
|
4170
4366
|
}
|
|
4171
|
-
interface
|
|
4172
|
-
createdEvent?: EntityCreatedEvent;
|
|
4173
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4174
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4175
|
-
actionEvent?: ActionEvent;
|
|
4176
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4177
|
-
_id?: string;
|
|
4367
|
+
interface BulkRevertToUnpublishedRequest {
|
|
4178
4368
|
/**
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4369
|
+
* Source post IDs.
|
|
4370
|
+
* @minSize 1
|
|
4371
|
+
* @maxSize 100
|
|
4372
|
+
* @format GUID
|
|
4181
4373
|
*/
|
|
4182
|
-
|
|
4374
|
+
postIds?: string[];
|
|
4375
|
+
/** Should full draft post be returned. */
|
|
4376
|
+
returnFullEntity?: boolean;
|
|
4377
|
+
}
|
|
4378
|
+
interface BulkRevertToUnpublishedResponse {
|
|
4379
|
+
/** Bulk action results. */
|
|
4380
|
+
results?: BulkDraftPostResult[];
|
|
4381
|
+
/** Bulk action metadata. */
|
|
4382
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4383
|
+
}
|
|
4384
|
+
interface BulkRejectDraftPostRequest {
|
|
4183
4385
|
/**
|
|
4184
|
-
*
|
|
4185
|
-
*
|
|
4386
|
+
* Source post IDs.
|
|
4387
|
+
* @minSize 1
|
|
4388
|
+
* @maxSize 100
|
|
4389
|
+
* @format GUID
|
|
4186
4390
|
*/
|
|
4187
|
-
|
|
4188
|
-
/**
|
|
4189
|
-
|
|
4190
|
-
|
|
4191
|
-
|
|
4391
|
+
postIds?: string[];
|
|
4392
|
+
/** Should full draft post be returned. */
|
|
4393
|
+
returnFullEntity?: boolean;
|
|
4394
|
+
}
|
|
4395
|
+
interface BulkRejectDraftPostResponse {
|
|
4396
|
+
/** Bulk action results. */
|
|
4397
|
+
results?: BulkDraftPostResult[];
|
|
4398
|
+
/** Bulk action metadata. */
|
|
4399
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4400
|
+
}
|
|
4401
|
+
interface RevertToUnpublishedRequest {
|
|
4192
4402
|
/**
|
|
4193
|
-
*
|
|
4194
|
-
*
|
|
4403
|
+
* Source post ID.
|
|
4404
|
+
* @format GUID
|
|
4195
4405
|
*/
|
|
4196
|
-
|
|
4197
|
-
/** If present, indicates the action that triggered the event. */
|
|
4198
|
-
originatedFrom?: string | null;
|
|
4406
|
+
postId?: string;
|
|
4199
4407
|
/**
|
|
4200
|
-
*
|
|
4201
|
-
*
|
|
4408
|
+
* List of draft post fields to be included in the response.
|
|
4409
|
+
* @internal
|
|
4410
|
+
* @maxSize 10
|
|
4411
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4412
|
+
* @replacedBy fieldsets
|
|
4413
|
+
* @targetRemovalDate 2024-06-30
|
|
4202
4414
|
*/
|
|
4203
|
-
|
|
4204
|
-
}
|
|
4205
|
-
/** @oneof */
|
|
4206
|
-
interface DomainEventBodyOneOf {
|
|
4207
|
-
createdEvent?: EntityCreatedEvent;
|
|
4208
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4209
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4210
|
-
actionEvent?: ActionEvent;
|
|
4211
|
-
}
|
|
4212
|
-
interface EntityCreatedEvent {
|
|
4213
|
-
entity?: string;
|
|
4214
|
-
}
|
|
4215
|
-
interface RestoreInfo {
|
|
4216
|
-
deletedDate?: Date | null;
|
|
4217
|
-
}
|
|
4218
|
-
interface EntityUpdatedEvent {
|
|
4415
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4219
4416
|
/**
|
|
4220
|
-
*
|
|
4221
|
-
*
|
|
4222
|
-
*
|
|
4417
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4418
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4419
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4420
|
+
* @maxSize 10
|
|
4223
4421
|
*/
|
|
4224
|
-
|
|
4225
|
-
}
|
|
4226
|
-
interface EntityDeletedEvent {
|
|
4227
|
-
/** Entity that was deleted. */
|
|
4228
|
-
deletedEntity?: string | null;
|
|
4229
|
-
}
|
|
4230
|
-
interface ActionEvent {
|
|
4231
|
-
body?: string;
|
|
4422
|
+
fieldsets?: FieldWithLiterals[];
|
|
4232
4423
|
}
|
|
4233
|
-
interface
|
|
4234
|
-
/**
|
|
4235
|
-
|
|
4236
|
-
* @format GUID
|
|
4237
|
-
*/
|
|
4238
|
-
instanceId?: string | null;
|
|
4239
|
-
/**
|
|
4240
|
-
* Event type.
|
|
4241
|
-
* @maxLength 150
|
|
4242
|
-
*/
|
|
4243
|
-
eventType?: string;
|
|
4244
|
-
/** The identification type and identity data. */
|
|
4245
|
-
identity?: IdentificationData;
|
|
4246
|
-
/** Stringify payload. */
|
|
4247
|
-
data?: string;
|
|
4248
|
-
/** Details related to the account */
|
|
4249
|
-
accountInfo?: AccountInfo;
|
|
4424
|
+
interface RevertToUnpublishedResponse {
|
|
4425
|
+
/** Updated post draft. */
|
|
4426
|
+
draftPost?: DraftPost;
|
|
4250
4427
|
}
|
|
4251
|
-
interface
|
|
4252
|
-
/**
|
|
4253
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4254
|
-
* @format GUID
|
|
4255
|
-
*/
|
|
4256
|
-
anonymousVisitorId?: string;
|
|
4428
|
+
interface RejectDraftPostRequest {
|
|
4257
4429
|
/**
|
|
4258
|
-
*
|
|
4430
|
+
* Source post ID.
|
|
4259
4431
|
* @format GUID
|
|
4260
4432
|
*/
|
|
4261
|
-
|
|
4433
|
+
postId?: string;
|
|
4262
4434
|
/**
|
|
4263
|
-
*
|
|
4264
|
-
* @
|
|
4435
|
+
* List of draft post fields to be included in the response.
|
|
4436
|
+
* @internal
|
|
4437
|
+
* @maxSize 10
|
|
4438
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4439
|
+
* @replacedBy fieldsets
|
|
4440
|
+
* @targetRemovalDate 2024-06-30
|
|
4265
4441
|
*/
|
|
4266
|
-
|
|
4442
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4267
4443
|
/**
|
|
4268
|
-
*
|
|
4269
|
-
*
|
|
4444
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4445
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4446
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4447
|
+
* @maxSize 10
|
|
4270
4448
|
*/
|
|
4271
|
-
|
|
4272
|
-
/** @readonly */
|
|
4273
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4449
|
+
fieldsets?: FieldWithLiterals[];
|
|
4274
4450
|
}
|
|
4275
|
-
|
|
4276
|
-
|
|
4451
|
+
interface RejectDraftPostResponse {
|
|
4452
|
+
/** Draft post. */
|
|
4453
|
+
draftPost?: DraftPost;
|
|
4454
|
+
}
|
|
4455
|
+
interface ApproveDraftPostRequest {
|
|
4277
4456
|
/**
|
|
4278
|
-
*
|
|
4457
|
+
* Source post ID.
|
|
4279
4458
|
* @format GUID
|
|
4280
4459
|
*/
|
|
4281
|
-
|
|
4460
|
+
postId?: string;
|
|
4282
4461
|
/**
|
|
4283
|
-
*
|
|
4284
|
-
* @
|
|
4462
|
+
* Scheduled publish date if should be not immediately published.
|
|
4463
|
+
* @maxLength 24
|
|
4285
4464
|
*/
|
|
4286
|
-
|
|
4465
|
+
scheduledPublishDate?: string | null;
|
|
4287
4466
|
/**
|
|
4288
|
-
*
|
|
4289
|
-
* @
|
|
4467
|
+
* List of draft post fields to be included in the response.
|
|
4468
|
+
* @internal
|
|
4469
|
+
* @maxSize 10
|
|
4470
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4471
|
+
* @replacedBy fieldsets
|
|
4472
|
+
* @targetRemovalDate 2024-06-30
|
|
4290
4473
|
*/
|
|
4291
|
-
|
|
4474
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4292
4475
|
/**
|
|
4293
|
-
*
|
|
4294
|
-
*
|
|
4476
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4477
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4478
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4479
|
+
* @maxSize 10
|
|
4295
4480
|
*/
|
|
4296
|
-
|
|
4481
|
+
fieldsets?: FieldWithLiterals[];
|
|
4297
4482
|
}
|
|
4298
|
-
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
MEMBER = "MEMBER",
|
|
4302
|
-
WIX_USER = "WIX_USER",
|
|
4303
|
-
APP = "APP"
|
|
4483
|
+
interface ApproveDraftPostResponse {
|
|
4484
|
+
/** Updated post draft. */
|
|
4485
|
+
draftPost?: DraftPost;
|
|
4304
4486
|
}
|
|
4305
|
-
|
|
4306
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4307
|
-
interface AccountInfo {
|
|
4308
|
-
/**
|
|
4309
|
-
* ID of the Wix account associated with the event.
|
|
4310
|
-
* @format GUID
|
|
4311
|
-
*/
|
|
4312
|
-
accountId?: string | null;
|
|
4313
|
-
/**
|
|
4314
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
4315
|
-
* @format GUID
|
|
4316
|
-
*/
|
|
4317
|
-
parentAccountId?: string | null;
|
|
4487
|
+
interface MarkPostAsInModerationRequest {
|
|
4318
4488
|
/**
|
|
4319
|
-
*
|
|
4320
|
-
* @
|
|
4489
|
+
* Source post ID.
|
|
4490
|
+
* @maxLength 38
|
|
4321
4491
|
*/
|
|
4322
|
-
|
|
4323
|
-
}
|
|
4324
|
-
interface GetDraftPostTotalsRequest {
|
|
4492
|
+
postId?: string;
|
|
4325
4493
|
/**
|
|
4326
|
-
*
|
|
4327
|
-
*
|
|
4328
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
4494
|
+
* List of draft post fields to be included in the response.
|
|
4495
|
+
* @internal
|
|
4329
4496
|
* @maxSize 10
|
|
4497
|
+
* @deprecated List of draft post fields to be included in the response.
|
|
4498
|
+
* @replacedBy fieldsets
|
|
4499
|
+
* @targetRemovalDate 2024-06-30
|
|
4330
4500
|
*/
|
|
4331
|
-
|
|
4501
|
+
fieldsToInclude?: FieldWithLiterals[];
|
|
4332
4502
|
/**
|
|
4333
|
-
*
|
|
4334
|
-
*
|
|
4503
|
+
* List of draft post fields to be included if entities are present in the response.
|
|
4504
|
+
* Base fieldset, which is default, will return all core draft post properties.
|
|
4505
|
+
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4506
|
+
* @maxSize 10
|
|
4335
4507
|
*/
|
|
4336
|
-
|
|
4337
|
-
}
|
|
4338
|
-
declare enum TotalDraftPostsGroupingField {
|
|
4339
|
-
/** Groups results by status. */
|
|
4340
|
-
STATUS = "STATUS",
|
|
4341
|
-
/** Groups results by language. */
|
|
4342
|
-
LANGUAGE = "LANGUAGE"
|
|
4343
|
-
}
|
|
4344
|
-
/** @enumType */
|
|
4345
|
-
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
4346
|
-
interface GetDraftPostTotalsResponse {
|
|
4347
|
-
/** Draft post totals. */
|
|
4348
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
4508
|
+
fieldsets?: FieldWithLiterals[];
|
|
4349
4509
|
}
|
|
4350
|
-
interface
|
|
4351
|
-
/**
|
|
4352
|
-
|
|
4353
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
4354
|
-
status?: StatusWithLiterals;
|
|
4355
|
-
/**
|
|
4356
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
4357
|
-
* @format LANGUAGE_TAG
|
|
4358
|
-
*/
|
|
4359
|
-
language?: string | null;
|
|
4510
|
+
interface MarkPostAsInModerationResponse {
|
|
4511
|
+
/** Updated post draft. */
|
|
4512
|
+
draftPost?: DraftPost;
|
|
4360
4513
|
}
|
|
4361
4514
|
interface TranslateDraftRequest {
|
|
4362
4515
|
/**
|
|
@@ -4450,153 +4603,6 @@ interface UpdateDraftPostLanguageResponse {
|
|
|
4450
4603
|
/** Updated draft post. */
|
|
4451
4604
|
draftPost?: DraftPost;
|
|
4452
4605
|
}
|
|
4453
|
-
interface BulkRevertToUnpublishedRequest {
|
|
4454
|
-
/**
|
|
4455
|
-
* Source post IDs.
|
|
4456
|
-
* @minSize 1
|
|
4457
|
-
* @maxSize 100
|
|
4458
|
-
* @format GUID
|
|
4459
|
-
*/
|
|
4460
|
-
postIds?: string[];
|
|
4461
|
-
/** Should full draft post be returned. */
|
|
4462
|
-
returnFullEntity?: boolean;
|
|
4463
|
-
}
|
|
4464
|
-
interface BulkRevertToUnpublishedResponse {
|
|
4465
|
-
/** Bulk action results. */
|
|
4466
|
-
results?: BulkDraftPostResult[];
|
|
4467
|
-
/** Bulk action metadata. */
|
|
4468
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4469
|
-
}
|
|
4470
|
-
interface BulkRejectDraftPostRequest {
|
|
4471
|
-
/**
|
|
4472
|
-
* Source post IDs.
|
|
4473
|
-
* @minSize 1
|
|
4474
|
-
* @maxSize 100
|
|
4475
|
-
* @format GUID
|
|
4476
|
-
*/
|
|
4477
|
-
postIds?: string[];
|
|
4478
|
-
/** Should full draft post be returned. */
|
|
4479
|
-
returnFullEntity?: boolean;
|
|
4480
|
-
}
|
|
4481
|
-
interface BulkRejectDraftPostResponse {
|
|
4482
|
-
/** Bulk action results. */
|
|
4483
|
-
results?: BulkDraftPostResult[];
|
|
4484
|
-
/** Bulk action metadata. */
|
|
4485
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4486
|
-
}
|
|
4487
|
-
interface RevertToUnpublishedRequest {
|
|
4488
|
-
/**
|
|
4489
|
-
* Source post ID.
|
|
4490
|
-
* @format GUID
|
|
4491
|
-
*/
|
|
4492
|
-
postId?: string;
|
|
4493
|
-
/**
|
|
4494
|
-
* List of draft post fields to be included in the response.
|
|
4495
|
-
* @internal
|
|
4496
|
-
* @maxSize 10
|
|
4497
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4498
|
-
* @replacedBy fieldsets
|
|
4499
|
-
* @targetRemovalDate 2024-06-30
|
|
4500
|
-
*/
|
|
4501
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4502
|
-
/**
|
|
4503
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4504
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4505
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4506
|
-
* @maxSize 10
|
|
4507
|
-
*/
|
|
4508
|
-
fieldsets?: FieldWithLiterals[];
|
|
4509
|
-
}
|
|
4510
|
-
interface RevertToUnpublishedResponse {
|
|
4511
|
-
/** Updated post draft. */
|
|
4512
|
-
draftPost?: DraftPost;
|
|
4513
|
-
}
|
|
4514
|
-
interface RejectDraftPostRequest {
|
|
4515
|
-
/**
|
|
4516
|
-
* Source post ID.
|
|
4517
|
-
* @format GUID
|
|
4518
|
-
*/
|
|
4519
|
-
postId?: string;
|
|
4520
|
-
/**
|
|
4521
|
-
* List of draft post fields to be included in the response.
|
|
4522
|
-
* @internal
|
|
4523
|
-
* @maxSize 10
|
|
4524
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4525
|
-
* @replacedBy fieldsets
|
|
4526
|
-
* @targetRemovalDate 2024-06-30
|
|
4527
|
-
*/
|
|
4528
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4529
|
-
/**
|
|
4530
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4531
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4532
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4533
|
-
* @maxSize 10
|
|
4534
|
-
*/
|
|
4535
|
-
fieldsets?: FieldWithLiterals[];
|
|
4536
|
-
}
|
|
4537
|
-
interface RejectDraftPostResponse {
|
|
4538
|
-
/** Draft post. */
|
|
4539
|
-
draftPost?: DraftPost;
|
|
4540
|
-
}
|
|
4541
|
-
interface ApproveDraftPostRequest {
|
|
4542
|
-
/**
|
|
4543
|
-
* Source post ID.
|
|
4544
|
-
* @format GUID
|
|
4545
|
-
*/
|
|
4546
|
-
postId?: string;
|
|
4547
|
-
/**
|
|
4548
|
-
* Scheduled publish date if should be not immediately published.
|
|
4549
|
-
* @maxLength 24
|
|
4550
|
-
*/
|
|
4551
|
-
scheduledPublishDate?: string | null;
|
|
4552
|
-
/**
|
|
4553
|
-
* List of draft post fields to be included in the response.
|
|
4554
|
-
* @internal
|
|
4555
|
-
* @maxSize 10
|
|
4556
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4557
|
-
* @replacedBy fieldsets
|
|
4558
|
-
* @targetRemovalDate 2024-06-30
|
|
4559
|
-
*/
|
|
4560
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4561
|
-
/**
|
|
4562
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4563
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4564
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4565
|
-
* @maxSize 10
|
|
4566
|
-
*/
|
|
4567
|
-
fieldsets?: FieldWithLiterals[];
|
|
4568
|
-
}
|
|
4569
|
-
interface ApproveDraftPostResponse {
|
|
4570
|
-
/** Updated post draft. */
|
|
4571
|
-
draftPost?: DraftPost;
|
|
4572
|
-
}
|
|
4573
|
-
interface MarkPostAsInModerationRequest {
|
|
4574
|
-
/**
|
|
4575
|
-
* Source post ID.
|
|
4576
|
-
* @maxLength 38
|
|
4577
|
-
*/
|
|
4578
|
-
postId?: string;
|
|
4579
|
-
/**
|
|
4580
|
-
* List of draft post fields to be included in the response.
|
|
4581
|
-
* @internal
|
|
4582
|
-
* @maxSize 10
|
|
4583
|
-
* @deprecated List of draft post fields to be included in the response.
|
|
4584
|
-
* @replacedBy fieldsets
|
|
4585
|
-
* @targetRemovalDate 2024-06-30
|
|
4586
|
-
*/
|
|
4587
|
-
fieldsToInclude?: FieldWithLiterals[];
|
|
4588
|
-
/**
|
|
4589
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
4590
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
4591
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
4592
|
-
* @maxSize 10
|
|
4593
|
-
*/
|
|
4594
|
-
fieldsets?: FieldWithLiterals[];
|
|
4595
|
-
}
|
|
4596
|
-
interface MarkPostAsInModerationResponse {
|
|
4597
|
-
/** Updated post draft. */
|
|
4598
|
-
draftPost?: DraftPost;
|
|
4599
|
-
}
|
|
4600
4606
|
interface BaseEventMetadata {
|
|
4601
4607
|
/**
|
|
4602
4608
|
* App instance ID.
|
|
@@ -5093,6 +5099,12 @@ interface UpdateDraftPost {
|
|
|
5093
5099
|
* @format GUID
|
|
5094
5100
|
*/
|
|
5095
5101
|
originPostInstanceId?: string | null;
|
|
5102
|
+
/**
|
|
5103
|
+
* Date the published post is automatically unpublished and reverted to a draft.
|
|
5104
|
+
* Must be in the future, at most one year ahead, and later than `scheduled_publish_date` when the draft post is scheduled.
|
|
5105
|
+
* @internal
|
|
5106
|
+
*/
|
|
5107
|
+
expirationDate?: Date | null;
|
|
5096
5108
|
/**
|
|
5097
5109
|
* Reserved for internal use.
|
|
5098
5110
|
* @internal
|