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