@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
|
|
@@ -3593,10 +3599,6 @@ interface DraftPostTranslation {
|
|
|
3593
3599
|
/** Post URL. */
|
|
3594
3600
|
url?: PageUrl;
|
|
3595
3601
|
}
|
|
3596
|
-
interface InitialDraftPostsCopied {
|
|
3597
|
-
/** Number of draft posts copied. */
|
|
3598
|
-
count?: number;
|
|
3599
|
-
}
|
|
3600
3602
|
interface DraftCategoriesUpdated {
|
|
3601
3603
|
/**
|
|
3602
3604
|
* Draft post ID.
|
|
@@ -3635,6 +3637,244 @@ interface DraftTagsUpdated {
|
|
|
3635
3637
|
*/
|
|
3636
3638
|
previousTags?: string[];
|
|
3637
3639
|
}
|
|
3640
|
+
interface GetDraftPostTotalsRequest {
|
|
3641
|
+
/**
|
|
3642
|
+
* Group results by fields (defaults to grouping by status).
|
|
3643
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
3644
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
3645
|
+
* @maxSize 10
|
|
3646
|
+
*/
|
|
3647
|
+
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
3648
|
+
/**
|
|
3649
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
3650
|
+
* @format LANGUAGE_TAG
|
|
3651
|
+
*/
|
|
3652
|
+
language?: string | null;
|
|
3653
|
+
}
|
|
3654
|
+
declare enum TotalDraftPostsGroupingField {
|
|
3655
|
+
/** Groups results by status. */
|
|
3656
|
+
STATUS = "STATUS",
|
|
3657
|
+
/** Groups results by language. */
|
|
3658
|
+
LANGUAGE = "LANGUAGE"
|
|
3659
|
+
}
|
|
3660
|
+
/** @enumType */
|
|
3661
|
+
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
3662
|
+
interface GetDraftPostTotalsResponse {
|
|
3663
|
+
/** Draft post totals. */
|
|
3664
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
3665
|
+
}
|
|
3666
|
+
interface TotalDraftPosts {
|
|
3667
|
+
/** Draft post totals in that group. */
|
|
3668
|
+
total?: number;
|
|
3669
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
3670
|
+
status?: StatusWithLiterals;
|
|
3671
|
+
/**
|
|
3672
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
3673
|
+
* @format LANGUAGE_TAG
|
|
3674
|
+
*/
|
|
3675
|
+
language?: string | null;
|
|
3676
|
+
}
|
|
3677
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3678
|
+
createdEvent?: EntityCreatedEvent;
|
|
3679
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3680
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3681
|
+
actionEvent?: ActionEvent;
|
|
3682
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3683
|
+
id?: string;
|
|
3684
|
+
/**
|
|
3685
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3686
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3687
|
+
*/
|
|
3688
|
+
entityFqdn?: string;
|
|
3689
|
+
/**
|
|
3690
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3691
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3692
|
+
*/
|
|
3693
|
+
slug?: string;
|
|
3694
|
+
/** ID of the entity associated with the event. */
|
|
3695
|
+
entityId?: string;
|
|
3696
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3697
|
+
eventTime?: Date | null;
|
|
3698
|
+
/**
|
|
3699
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3700
|
+
* (for example, GDPR).
|
|
3701
|
+
*/
|
|
3702
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3703
|
+
/** If present, indicates the action that triggered the event. */
|
|
3704
|
+
originatedFrom?: string | null;
|
|
3705
|
+
/**
|
|
3706
|
+
* 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.
|
|
3707
|
+
* 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.
|
|
3708
|
+
*/
|
|
3709
|
+
entityEventSequence?: string | null;
|
|
3710
|
+
}
|
|
3711
|
+
/** @oneof */
|
|
3712
|
+
interface DomainEventBodyOneOf {
|
|
3713
|
+
createdEvent?: EntityCreatedEvent;
|
|
3714
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3715
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3716
|
+
actionEvent?: ActionEvent;
|
|
3717
|
+
}
|
|
3718
|
+
interface EntityCreatedEvent {
|
|
3719
|
+
entityAsJson?: string;
|
|
3720
|
+
/**
|
|
3721
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
3722
|
+
* @internal
|
|
3723
|
+
*/
|
|
3724
|
+
triggeredByUndelete?: boolean | null;
|
|
3725
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3726
|
+
restoreInfo?: RestoreInfo;
|
|
3727
|
+
/**
|
|
3728
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3729
|
+
* @internal
|
|
3730
|
+
*/
|
|
3731
|
+
additionalMetadataAsJson?: string | null;
|
|
3732
|
+
}
|
|
3733
|
+
interface RestoreInfo {
|
|
3734
|
+
deletedDate?: Date | null;
|
|
3735
|
+
}
|
|
3736
|
+
interface EntityUpdatedEvent {
|
|
3737
|
+
/**
|
|
3738
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3739
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3740
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3741
|
+
*/
|
|
3742
|
+
currentEntityAsJson?: string;
|
|
3743
|
+
/**
|
|
3744
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
3745
|
+
* wont populate it / have any reference to it in the API.
|
|
3746
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
3747
|
+
* the developer should send only the new (current) entity.
|
|
3748
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
3749
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
3750
|
+
* @internal
|
|
3751
|
+
* @deprecated
|
|
3752
|
+
*/
|
|
3753
|
+
previousEntityAsJson?: string | null;
|
|
3754
|
+
/**
|
|
3755
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
3756
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
3757
|
+
* @internal
|
|
3758
|
+
*/
|
|
3759
|
+
modifiedFields?: Record<string, any>;
|
|
3760
|
+
/**
|
|
3761
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3762
|
+
* @internal
|
|
3763
|
+
*/
|
|
3764
|
+
additionalMetadataAsJson?: string | null;
|
|
3765
|
+
}
|
|
3766
|
+
interface EntityDeletedEvent {
|
|
3767
|
+
/**
|
|
3768
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
3769
|
+
* @internal
|
|
3770
|
+
*/
|
|
3771
|
+
movedToTrash?: boolean | null;
|
|
3772
|
+
/** Entity that was deleted. */
|
|
3773
|
+
deletedEntityAsJson?: string | null;
|
|
3774
|
+
/**
|
|
3775
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3776
|
+
* @internal
|
|
3777
|
+
*/
|
|
3778
|
+
additionalMetadataAsJson?: string | null;
|
|
3779
|
+
}
|
|
3780
|
+
interface ActionEvent {
|
|
3781
|
+
bodyAsJson?: string;
|
|
3782
|
+
}
|
|
3783
|
+
interface MessageEnvelope {
|
|
3784
|
+
/**
|
|
3785
|
+
* App instance ID.
|
|
3786
|
+
* @format GUID
|
|
3787
|
+
*/
|
|
3788
|
+
instanceId?: string | null;
|
|
3789
|
+
/**
|
|
3790
|
+
* Event type.
|
|
3791
|
+
* @maxLength 150
|
|
3792
|
+
*/
|
|
3793
|
+
eventType?: string;
|
|
3794
|
+
/** The identification type and identity data. */
|
|
3795
|
+
identity?: IdentificationData;
|
|
3796
|
+
/** Stringify payload. */
|
|
3797
|
+
data?: string;
|
|
3798
|
+
/** Details related to the account */
|
|
3799
|
+
accountInfo?: AccountInfo;
|
|
3800
|
+
}
|
|
3801
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3802
|
+
/**
|
|
3803
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3804
|
+
* @format GUID
|
|
3805
|
+
*/
|
|
3806
|
+
anonymousVisitorId?: string;
|
|
3807
|
+
/**
|
|
3808
|
+
* ID of a site visitor that has logged in to the site.
|
|
3809
|
+
* @format GUID
|
|
3810
|
+
*/
|
|
3811
|
+
memberId?: string;
|
|
3812
|
+
/**
|
|
3813
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3814
|
+
* @format GUID
|
|
3815
|
+
*/
|
|
3816
|
+
wixUserId?: string;
|
|
3817
|
+
/**
|
|
3818
|
+
* ID of an app.
|
|
3819
|
+
* @format GUID
|
|
3820
|
+
*/
|
|
3821
|
+
appId?: string;
|
|
3822
|
+
/** @readonly */
|
|
3823
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3824
|
+
}
|
|
3825
|
+
/** @oneof */
|
|
3826
|
+
interface IdentificationDataIdOneOf {
|
|
3827
|
+
/**
|
|
3828
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3829
|
+
* @format GUID
|
|
3830
|
+
*/
|
|
3831
|
+
anonymousVisitorId?: string;
|
|
3832
|
+
/**
|
|
3833
|
+
* ID of a site visitor that has logged in to the site.
|
|
3834
|
+
* @format GUID
|
|
3835
|
+
*/
|
|
3836
|
+
memberId?: string;
|
|
3837
|
+
/**
|
|
3838
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3839
|
+
* @format GUID
|
|
3840
|
+
*/
|
|
3841
|
+
wixUserId?: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* ID of an app.
|
|
3844
|
+
* @format GUID
|
|
3845
|
+
*/
|
|
3846
|
+
appId?: string;
|
|
3847
|
+
}
|
|
3848
|
+
declare enum WebhookIdentityType {
|
|
3849
|
+
UNKNOWN = "UNKNOWN",
|
|
3850
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3851
|
+
MEMBER = "MEMBER",
|
|
3852
|
+
WIX_USER = "WIX_USER",
|
|
3853
|
+
APP = "APP"
|
|
3854
|
+
}
|
|
3855
|
+
/** @enumType */
|
|
3856
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3857
|
+
interface AccountInfo {
|
|
3858
|
+
/**
|
|
3859
|
+
* ID of the Wix account associated with the event.
|
|
3860
|
+
* @format GUID
|
|
3861
|
+
*/
|
|
3862
|
+
accountId?: string | null;
|
|
3863
|
+
/**
|
|
3864
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
3865
|
+
* @format GUID
|
|
3866
|
+
*/
|
|
3867
|
+
parentAccountId?: string | null;
|
|
3868
|
+
/**
|
|
3869
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
3870
|
+
* @format GUID
|
|
3871
|
+
*/
|
|
3872
|
+
siteId?: string | null;
|
|
3873
|
+
}
|
|
3874
|
+
interface InitialDraftPostsCopied {
|
|
3875
|
+
/** Number of draft posts copied. */
|
|
3876
|
+
count?: number;
|
|
3877
|
+
}
|
|
3638
3878
|
interface CreateDraftPostRequest {
|
|
3639
3879
|
/** Draft post to create. */
|
|
3640
3880
|
draftPost: DraftPost;
|
|
@@ -4284,333 +4524,7 @@ interface DraftPostCount {
|
|
|
4284
4524
|
/** Number of posts. */
|
|
4285
4525
|
postCount?: number;
|
|
4286
4526
|
}
|
|
4287
|
-
interface
|
|
4288
|
-
createdEvent?: EntityCreatedEvent;
|
|
4289
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4290
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4291
|
-
actionEvent?: ActionEvent;
|
|
4292
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4293
|
-
id?: string;
|
|
4294
|
-
/**
|
|
4295
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4296
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4297
|
-
*/
|
|
4298
|
-
entityFqdn?: string;
|
|
4299
|
-
/**
|
|
4300
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4301
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4302
|
-
*/
|
|
4303
|
-
slug?: string;
|
|
4304
|
-
/** ID of the entity associated with the event. */
|
|
4305
|
-
entityId?: string;
|
|
4306
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4307
|
-
eventTime?: Date | null;
|
|
4308
|
-
/**
|
|
4309
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
4310
|
-
* (for example, GDPR).
|
|
4311
|
-
*/
|
|
4312
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
4313
|
-
/** If present, indicates the action that triggered the event. */
|
|
4314
|
-
originatedFrom?: string | null;
|
|
4315
|
-
/**
|
|
4316
|
-
* 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.
|
|
4317
|
-
* 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.
|
|
4318
|
-
*/
|
|
4319
|
-
entityEventSequence?: string | null;
|
|
4320
|
-
}
|
|
4321
|
-
/** @oneof */
|
|
4322
|
-
interface DomainEventBodyOneOf {
|
|
4323
|
-
createdEvent?: EntityCreatedEvent;
|
|
4324
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4325
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4326
|
-
actionEvent?: ActionEvent;
|
|
4327
|
-
}
|
|
4328
|
-
interface EntityCreatedEvent {
|
|
4329
|
-
entityAsJson?: string;
|
|
4330
|
-
/**
|
|
4331
|
-
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
4332
|
-
* @internal
|
|
4333
|
-
*/
|
|
4334
|
-
triggeredByUndelete?: boolean | null;
|
|
4335
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
4336
|
-
restoreInfo?: RestoreInfo;
|
|
4337
|
-
/**
|
|
4338
|
-
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
4339
|
-
* @internal
|
|
4340
|
-
*/
|
|
4341
|
-
additionalMetadataAsJson?: string | null;
|
|
4342
|
-
}
|
|
4343
|
-
interface RestoreInfo {
|
|
4344
|
-
deletedDate?: Date | null;
|
|
4345
|
-
}
|
|
4346
|
-
interface EntityUpdatedEvent {
|
|
4347
|
-
/**
|
|
4348
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4349
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4350
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4351
|
-
*/
|
|
4352
|
-
currentEntityAsJson?: string;
|
|
4353
|
-
/**
|
|
4354
|
-
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
4355
|
-
* wont populate it / have any reference to it in the API.
|
|
4356
|
-
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
4357
|
-
* the developer should send only the new (current) entity.
|
|
4358
|
-
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
4359
|
-
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
4360
|
-
* @internal
|
|
4361
|
-
* @deprecated
|
|
4362
|
-
*/
|
|
4363
|
-
previousEntityAsJson?: string | null;
|
|
4364
|
-
/**
|
|
4365
|
-
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
4366
|
-
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
4367
|
-
* @internal
|
|
4368
|
-
*/
|
|
4369
|
-
modifiedFields?: Record<string, any>;
|
|
4370
|
-
/**
|
|
4371
|
-
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
4372
|
-
* @internal
|
|
4373
|
-
*/
|
|
4374
|
-
additionalMetadataAsJson?: string | null;
|
|
4375
|
-
}
|
|
4376
|
-
interface EntityDeletedEvent {
|
|
4377
|
-
/**
|
|
4378
|
-
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
4379
|
-
* @internal
|
|
4380
|
-
*/
|
|
4381
|
-
movedToTrash?: boolean | null;
|
|
4382
|
-
/** Entity that was deleted. */
|
|
4383
|
-
deletedEntityAsJson?: string | null;
|
|
4384
|
-
/**
|
|
4385
|
-
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
4386
|
-
* @internal
|
|
4387
|
-
*/
|
|
4388
|
-
additionalMetadataAsJson?: string | null;
|
|
4389
|
-
}
|
|
4390
|
-
interface ActionEvent {
|
|
4391
|
-
bodyAsJson?: string;
|
|
4392
|
-
}
|
|
4393
|
-
interface MessageEnvelope {
|
|
4394
|
-
/**
|
|
4395
|
-
* App instance ID.
|
|
4396
|
-
* @format GUID
|
|
4397
|
-
*/
|
|
4398
|
-
instanceId?: string | null;
|
|
4399
|
-
/**
|
|
4400
|
-
* Event type.
|
|
4401
|
-
* @maxLength 150
|
|
4402
|
-
*/
|
|
4403
|
-
eventType?: string;
|
|
4404
|
-
/** The identification type and identity data. */
|
|
4405
|
-
identity?: IdentificationData;
|
|
4406
|
-
/** Stringify payload. */
|
|
4407
|
-
data?: string;
|
|
4408
|
-
/** Details related to the account */
|
|
4409
|
-
accountInfo?: AccountInfo;
|
|
4410
|
-
}
|
|
4411
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4412
|
-
/**
|
|
4413
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4414
|
-
* @format GUID
|
|
4415
|
-
*/
|
|
4416
|
-
anonymousVisitorId?: string;
|
|
4417
|
-
/**
|
|
4418
|
-
* ID of a site visitor that has logged in to the site.
|
|
4419
|
-
* @format GUID
|
|
4420
|
-
*/
|
|
4421
|
-
memberId?: string;
|
|
4422
|
-
/**
|
|
4423
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4424
|
-
* @format GUID
|
|
4425
|
-
*/
|
|
4426
|
-
wixUserId?: string;
|
|
4427
|
-
/**
|
|
4428
|
-
* ID of an app.
|
|
4429
|
-
* @format GUID
|
|
4430
|
-
*/
|
|
4431
|
-
appId?: string;
|
|
4432
|
-
/** @readonly */
|
|
4433
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4434
|
-
}
|
|
4435
|
-
/** @oneof */
|
|
4436
|
-
interface IdentificationDataIdOneOf {
|
|
4437
|
-
/**
|
|
4438
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4439
|
-
* @format GUID
|
|
4440
|
-
*/
|
|
4441
|
-
anonymousVisitorId?: string;
|
|
4442
|
-
/**
|
|
4443
|
-
* ID of a site visitor that has logged in to the site.
|
|
4444
|
-
* @format GUID
|
|
4445
|
-
*/
|
|
4446
|
-
memberId?: string;
|
|
4447
|
-
/**
|
|
4448
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4449
|
-
* @format GUID
|
|
4450
|
-
*/
|
|
4451
|
-
wixUserId?: string;
|
|
4452
|
-
/**
|
|
4453
|
-
* ID of an app.
|
|
4454
|
-
* @format GUID
|
|
4455
|
-
*/
|
|
4456
|
-
appId?: string;
|
|
4457
|
-
}
|
|
4458
|
-
declare enum WebhookIdentityType {
|
|
4459
|
-
UNKNOWN = "UNKNOWN",
|
|
4460
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4461
|
-
MEMBER = "MEMBER",
|
|
4462
|
-
WIX_USER = "WIX_USER",
|
|
4463
|
-
APP = "APP"
|
|
4464
|
-
}
|
|
4465
|
-
/** @enumType */
|
|
4466
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4467
|
-
interface AccountInfo {
|
|
4468
|
-
/**
|
|
4469
|
-
* ID of the Wix account associated with the event.
|
|
4470
|
-
* @format GUID
|
|
4471
|
-
*/
|
|
4472
|
-
accountId?: string | null;
|
|
4473
|
-
/**
|
|
4474
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
4475
|
-
* @format GUID
|
|
4476
|
-
*/
|
|
4477
|
-
parentAccountId?: string | null;
|
|
4478
|
-
/**
|
|
4479
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
4480
|
-
* @format GUID
|
|
4481
|
-
*/
|
|
4482
|
-
siteId?: string | null;
|
|
4483
|
-
}
|
|
4484
|
-
interface GetDraftPostTotalsRequest {
|
|
4485
|
-
/**
|
|
4486
|
-
* Group results by fields (defaults to grouping by status).
|
|
4487
|
-
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
4488
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
4489
|
-
* @maxSize 10
|
|
4490
|
-
*/
|
|
4491
|
-
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
4492
|
-
/**
|
|
4493
|
-
* Optional language filter by provided language code. Useful in multilingual context.
|
|
4494
|
-
* @format LANGUAGE_TAG
|
|
4495
|
-
*/
|
|
4496
|
-
language?: string | null;
|
|
4497
|
-
}
|
|
4498
|
-
declare enum TotalDraftPostsGroupingField {
|
|
4499
|
-
/** Groups results by status. */
|
|
4500
|
-
STATUS = "STATUS",
|
|
4501
|
-
/** Groups results by language. */
|
|
4502
|
-
LANGUAGE = "LANGUAGE"
|
|
4503
|
-
}
|
|
4504
|
-
/** @enumType */
|
|
4505
|
-
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
4506
|
-
interface GetDraftPostTotalsResponse {
|
|
4507
|
-
/** Draft post totals. */
|
|
4508
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
4509
|
-
}
|
|
4510
|
-
interface TotalDraftPosts {
|
|
4511
|
-
/** Draft post totals in that group. */
|
|
4512
|
-
total?: number;
|
|
4513
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
4514
|
-
status?: StatusWithLiterals;
|
|
4515
|
-
/**
|
|
4516
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
4517
|
-
* @format LANGUAGE_TAG
|
|
4518
|
-
*/
|
|
4519
|
-
language?: string | null;
|
|
4520
|
-
}
|
|
4521
|
-
interface TranslateDraftRequest {
|
|
4522
|
-
/**
|
|
4523
|
-
* ID of the draft post or published post to translate.
|
|
4524
|
-
* @format GUID
|
|
4525
|
-
*/
|
|
4526
|
-
postId: string;
|
|
4527
|
-
/**
|
|
4528
|
-
* Language to translate the post into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4529
|
-
* For example, `de` for German, or `pt-br` for Brazilian Portuguese.
|
|
4530
|
-
* @format LANGUAGE_TAG
|
|
4531
|
-
*/
|
|
4532
|
-
language: string;
|
|
4533
|
-
/**
|
|
4534
|
-
* Predefined sets of fields to return in the created draft post, in addition to the core draft post fields.
|
|
4535
|
-
*
|
|
4536
|
-
* - `URL`: Returns the draft post's preview URL.
|
|
4537
|
-
* - `CONTENT`: Returns the draft post's content.
|
|
4538
|
-
* - `RICH_CONTENT`: Returns the draft post's rich content.
|
|
4539
|
-
* - `GENERATED_EXCERPT`: Returns an excerpt generated from the content if a custom excerpt isn't set.
|
|
4540
|
-
*
|
|
4541
|
-
* Default: Core draft post fields only.
|
|
4542
|
-
* @maxSize 10
|
|
4543
|
-
*/
|
|
4544
|
-
fieldsets?: FieldWithLiterals[];
|
|
4545
|
-
/**
|
|
4546
|
-
* Whether to machine translate the title and content into the target language.
|
|
4547
|
-
*
|
|
4548
|
-
* Default: `false`
|
|
4549
|
-
* @internal
|
|
4550
|
-
*/
|
|
4551
|
-
useAutoTranslation?: boolean;
|
|
4552
|
-
}
|
|
4553
|
-
interface TranslateDraftResponse {
|
|
4554
|
-
/** Created draft post. */
|
|
4555
|
-
draftPost?: DraftPost;
|
|
4556
|
-
}
|
|
4557
|
-
interface IsDraftPostAutoTranslatableRequest {
|
|
4558
|
-
/**
|
|
4559
|
-
* Draft post ID.
|
|
4560
|
-
* @format GUID
|
|
4561
|
-
*/
|
|
4562
|
-
draftPostId?: string;
|
|
4563
|
-
}
|
|
4564
|
-
interface IsDraftPostAutoTranslatableResponse {
|
|
4565
|
-
/**
|
|
4566
|
-
* Draft post ID.
|
|
4567
|
-
* @format GUID
|
|
4568
|
-
*/
|
|
4569
|
-
draftPostId?: string;
|
|
4570
|
-
/** Whether enough machine translation word credits are available to translate the draft post. */
|
|
4571
|
-
translatable?: boolean;
|
|
4572
|
-
/** Number of words in the draft post's title. */
|
|
4573
|
-
titleWordCount?: number;
|
|
4574
|
-
/** Number of words in the draft post's content. */
|
|
4575
|
-
contentWordCount?: number;
|
|
4576
|
-
/** Number of machine translation word credits currently available. `-1` if the site's quota is unlimited. */
|
|
4577
|
-
availableAutoTranslateWords?: number;
|
|
4578
|
-
/** Number of machine translation word credits that remain after translating the draft post. `-1` if the site's quota is unlimited. */
|
|
4579
|
-
availableAutoTranslateWordsAfter?: number;
|
|
4580
|
-
/** Number of characters in the draft post's plain text content. */
|
|
4581
|
-
contentTextCharacterCount?: number;
|
|
4582
|
-
}
|
|
4583
|
-
interface UpdateDraftPostLanguageRequest {
|
|
4584
|
-
/**
|
|
4585
|
-
* ID of the draft post to update.
|
|
4586
|
-
* @format GUID
|
|
4587
|
-
*/
|
|
4588
|
-
postId: string;
|
|
4589
|
-
/**
|
|
4590
|
-
* New language of the draft post, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4591
|
-
* For example, `de` for German, or `pt-br` for Brazilian Portuguese.
|
|
4592
|
-
* @minLength 2
|
|
4593
|
-
* @format LANGUAGE_TAG
|
|
4594
|
-
*/
|
|
4595
|
-
language: string;
|
|
4596
|
-
/**
|
|
4597
|
-
* Predefined sets of fields to return in the updated draft post, in addition to the core draft post fields.
|
|
4598
|
-
*
|
|
4599
|
-
* - `URL`: Returns the draft post's preview URL.
|
|
4600
|
-
* - `CONTENT`: Returns the draft post's content.
|
|
4601
|
-
* - `RICH_CONTENT`: Returns the draft post's rich content.
|
|
4602
|
-
* - `GENERATED_EXCERPT`: Returns an excerpt generated from the content if a custom excerpt isn't set.
|
|
4603
|
-
*
|
|
4604
|
-
* Default: Core draft post fields only.
|
|
4605
|
-
* @maxSize 10
|
|
4606
|
-
*/
|
|
4607
|
-
fieldsets?: FieldWithLiterals[];
|
|
4608
|
-
}
|
|
4609
|
-
interface UpdateDraftPostLanguageResponse {
|
|
4610
|
-
/** Updated draft post. */
|
|
4611
|
-
draftPost?: DraftPost;
|
|
4612
|
-
}
|
|
4613
|
-
interface BulkRevertToUnpublishedRequest {
|
|
4527
|
+
interface BulkRevertToUnpublishedRequest {
|
|
4614
4528
|
/**
|
|
4615
4529
|
* Source post IDs.
|
|
4616
4530
|
* @minSize 1
|
|
@@ -4757,6 +4671,98 @@ interface MarkPostAsInModerationResponse {
|
|
|
4757
4671
|
/** Updated post draft. */
|
|
4758
4672
|
draftPost?: DraftPost;
|
|
4759
4673
|
}
|
|
4674
|
+
interface TranslateDraftRequest {
|
|
4675
|
+
/**
|
|
4676
|
+
* ID of the draft post or published post to translate.
|
|
4677
|
+
* @format GUID
|
|
4678
|
+
*/
|
|
4679
|
+
postId: string;
|
|
4680
|
+
/**
|
|
4681
|
+
* Language to translate the post into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4682
|
+
* For example, `de` for German, or `pt-br` for Brazilian Portuguese.
|
|
4683
|
+
* @format LANGUAGE_TAG
|
|
4684
|
+
*/
|
|
4685
|
+
language: string;
|
|
4686
|
+
/**
|
|
4687
|
+
* Predefined sets of fields to return in the created draft post, in addition to the core draft post fields.
|
|
4688
|
+
*
|
|
4689
|
+
* - `URL`: Returns the draft post's preview URL.
|
|
4690
|
+
* - `CONTENT`: Returns the draft post's content.
|
|
4691
|
+
* - `RICH_CONTENT`: Returns the draft post's rich content.
|
|
4692
|
+
* - `GENERATED_EXCERPT`: Returns an excerpt generated from the content if a custom excerpt isn't set.
|
|
4693
|
+
*
|
|
4694
|
+
* Default: Core draft post fields only.
|
|
4695
|
+
* @maxSize 10
|
|
4696
|
+
*/
|
|
4697
|
+
fieldsets?: FieldWithLiterals[];
|
|
4698
|
+
/**
|
|
4699
|
+
* Whether to machine translate the title and content into the target language.
|
|
4700
|
+
*
|
|
4701
|
+
* Default: `false`
|
|
4702
|
+
* @internal
|
|
4703
|
+
*/
|
|
4704
|
+
useAutoTranslation?: boolean;
|
|
4705
|
+
}
|
|
4706
|
+
interface TranslateDraftResponse {
|
|
4707
|
+
/** Created draft post. */
|
|
4708
|
+
draftPost?: DraftPost;
|
|
4709
|
+
}
|
|
4710
|
+
interface IsDraftPostAutoTranslatableRequest {
|
|
4711
|
+
/**
|
|
4712
|
+
* Draft post ID.
|
|
4713
|
+
* @format GUID
|
|
4714
|
+
*/
|
|
4715
|
+
draftPostId?: string;
|
|
4716
|
+
}
|
|
4717
|
+
interface IsDraftPostAutoTranslatableResponse {
|
|
4718
|
+
/**
|
|
4719
|
+
* Draft post ID.
|
|
4720
|
+
* @format GUID
|
|
4721
|
+
*/
|
|
4722
|
+
draftPostId?: string;
|
|
4723
|
+
/** Whether enough machine translation word credits are available to translate the draft post. */
|
|
4724
|
+
translatable?: boolean;
|
|
4725
|
+
/** Number of words in the draft post's title. */
|
|
4726
|
+
titleWordCount?: number;
|
|
4727
|
+
/** Number of words in the draft post's content. */
|
|
4728
|
+
contentWordCount?: number;
|
|
4729
|
+
/** Number of machine translation word credits currently available. `-1` if the site's quota is unlimited. */
|
|
4730
|
+
availableAutoTranslateWords?: number;
|
|
4731
|
+
/** Number of machine translation word credits that remain after translating the draft post. `-1` if the site's quota is unlimited. */
|
|
4732
|
+
availableAutoTranslateWordsAfter?: number;
|
|
4733
|
+
/** Number of characters in the draft post's plain text content. */
|
|
4734
|
+
contentTextCharacterCount?: number;
|
|
4735
|
+
}
|
|
4736
|
+
interface UpdateDraftPostLanguageRequest {
|
|
4737
|
+
/**
|
|
4738
|
+
* ID of the draft post to update.
|
|
4739
|
+
* @format GUID
|
|
4740
|
+
*/
|
|
4741
|
+
postId: string;
|
|
4742
|
+
/**
|
|
4743
|
+
* New language of the draft post, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
4744
|
+
* For example, `de` for German, or `pt-br` for Brazilian Portuguese.
|
|
4745
|
+
* @minLength 2
|
|
4746
|
+
* @format LANGUAGE_TAG
|
|
4747
|
+
*/
|
|
4748
|
+
language: string;
|
|
4749
|
+
/**
|
|
4750
|
+
* Predefined sets of fields to return in the updated draft post, in addition to the core draft post fields.
|
|
4751
|
+
*
|
|
4752
|
+
* - `URL`: Returns the draft post's preview URL.
|
|
4753
|
+
* - `CONTENT`: Returns the draft post's content.
|
|
4754
|
+
* - `RICH_CONTENT`: Returns the draft post's rich content.
|
|
4755
|
+
* - `GENERATED_EXCERPT`: Returns an excerpt generated from the content if a custom excerpt isn't set.
|
|
4756
|
+
*
|
|
4757
|
+
* Default: Core draft post fields only.
|
|
4758
|
+
* @maxSize 10
|
|
4759
|
+
*/
|
|
4760
|
+
fieldsets?: FieldWithLiterals[];
|
|
4761
|
+
}
|
|
4762
|
+
interface UpdateDraftPostLanguageResponse {
|
|
4763
|
+
/** Updated draft post. */
|
|
4764
|
+
draftPost?: DraftPost;
|
|
4765
|
+
}
|
|
4760
4766
|
|
|
4761
4767
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4762
4768
|
getUrl: (context: any) => string;
|