@wix/multilingual 1.0.26 → 1.0.28

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.
@@ -103,11 +103,11 @@ interface SequencePath {
103
103
  }
104
104
  interface Empty$2 {
105
105
  }
106
- interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
107
- createdEvent?: EntityCreatedEvent$2;
108
- updatedEvent?: EntityUpdatedEvent$2;
109
- deletedEvent?: EntityDeletedEvent$2;
110
- actionEvent?: ActionEvent$2;
106
+ interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
107
+ createdEvent?: EntityCreatedEvent$3;
108
+ updatedEvent?: EntityUpdatedEvent$3;
109
+ deletedEvent?: EntityDeletedEvent$3;
110
+ actionEvent?: ActionEvent$3;
111
111
  /**
112
112
  * Unique event ID.
113
113
  * Allows clients to ignore duplicate webhooks.
@@ -146,19 +146,19 @@ interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
146
146
  entityEventSequence?: string | null;
147
147
  }
148
148
  /** @oneof */
149
- interface DomainEventBodyOneOf$2 {
150
- createdEvent?: EntityCreatedEvent$2;
151
- updatedEvent?: EntityUpdatedEvent$2;
152
- deletedEvent?: EntityDeletedEvent$2;
153
- actionEvent?: ActionEvent$2;
149
+ interface DomainEventBodyOneOf$3 {
150
+ createdEvent?: EntityCreatedEvent$3;
151
+ updatedEvent?: EntityUpdatedEvent$3;
152
+ deletedEvent?: EntityDeletedEvent$3;
153
+ actionEvent?: ActionEvent$3;
154
154
  }
155
- interface EntityCreatedEvent$2 {
155
+ interface EntityCreatedEvent$3 {
156
156
  entity?: string;
157
157
  }
158
- interface RestoreInfo$2 {
158
+ interface RestoreInfo$3 {
159
159
  deletedDate?: Date;
160
160
  }
161
- interface EntityUpdatedEvent$2 {
161
+ interface EntityUpdatedEvent$3 {
162
162
  /**
163
163
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
164
164
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -166,11 +166,11 @@ interface EntityUpdatedEvent$2 {
166
166
  */
167
167
  currentEntity?: string;
168
168
  }
169
- interface EntityDeletedEvent$2 {
169
+ interface EntityDeletedEvent$3 {
170
170
  /** Entity that was deleted */
171
171
  deletedEntity?: string | null;
172
172
  }
173
- interface ActionEvent$2 {
173
+ interface ActionEvent$3 {
174
174
  body?: string;
175
175
  }
176
176
  interface LocalizedPublishedLanguageContentChanged {
@@ -193,19 +193,19 @@ interface LocalizedPublishedContent {
193
193
  }
194
194
  interface LocalizedContentKey {
195
195
  /** Schema unique key identifier */
196
- schemaKey?: SchemaKey$1;
196
+ schemaKey?: SchemaKey$2;
197
197
  /** Unique identifier that represents a specific entity in the app */
198
198
  entityId?: string;
199
199
  }
200
- interface SchemaKey$1 {
200
+ interface SchemaKey$2 {
201
201
  /** ID of app that created the schema. */
202
202
  appId?: string;
203
203
  /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
204
204
  entityType?: string;
205
205
  /** Scope schema is defined in (Global/Site) */
206
- scope?: SchemaScope$1;
206
+ scope?: SchemaScope$2;
207
207
  }
208
- declare enum SchemaScope$1 {
208
+ declare enum SchemaScope$2 {
209
209
  /** Global schema, relevant to all sites */
210
210
  GLOBAL = "GLOBAL",
211
211
  /** Site schema, relevant to specific site only */
@@ -250,7 +250,7 @@ interface MediaItemMediaOneOf {
250
250
  /** Document media item */
251
251
  document?: string;
252
252
  }
253
- interface VideoResolution$1 {
253
+ interface VideoResolution$2 {
254
254
  /** Video URL. */
255
255
  url?: string;
256
256
  /** Video height. */
@@ -317,9 +317,1692 @@ interface DeleteEntityMapperResponse {
317
317
  }
318
318
  interface GetSubscribedTopicsRequest {
319
319
  }
320
- interface GetSubscribedTopicsResponse {
321
- /** List of subscribed topics */
322
- topics?: string[];
320
+ interface GetSubscribedTopicsResponse {
321
+ /** List of subscribed topics */
322
+ topics?: string[];
323
+ }
324
+ interface MessageEnvelope$3 {
325
+ /** App instance ID. */
326
+ instanceId?: string | null;
327
+ /** Event type. */
328
+ eventType?: string;
329
+ /** The identification type and identity data. */
330
+ identity?: IdentificationData$3;
331
+ /** Stringify payload. */
332
+ data?: string;
333
+ }
334
+ interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
335
+ /** ID of a site visitor that has not logged in to the site. */
336
+ anonymousVisitorId?: string;
337
+ /** ID of a site visitor that has logged in to the site. */
338
+ memberId?: string;
339
+ /** ID of a Wix user (site owner, contributor, etc.). */
340
+ wixUserId?: string;
341
+ /** ID of an app. */
342
+ appId?: string;
343
+ /** @readonly */
344
+ identityType?: WebhookIdentityType$3;
345
+ }
346
+ /** @oneof */
347
+ interface IdentificationDataIdOneOf$3 {
348
+ /** ID of a site visitor that has not logged in to the site. */
349
+ anonymousVisitorId?: string;
350
+ /** ID of a site visitor that has logged in to the site. */
351
+ memberId?: string;
352
+ /** ID of a Wix user (site owner, contributor, etc.). */
353
+ wixUserId?: string;
354
+ /** ID of an app. */
355
+ appId?: string;
356
+ }
357
+ declare enum WebhookIdentityType$3 {
358
+ UNKNOWN = "UNKNOWN",
359
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
360
+ MEMBER = "MEMBER",
361
+ WIX_USER = "WIX_USER",
362
+ APP = "APP"
363
+ }
364
+ interface HtmlNewRevisionSavedMessage {
365
+ /** HTML Site ID */
366
+ siteId?: string;
367
+ /** Newly saved revision */
368
+ revision?: string;
369
+ /** Restored from revision */
370
+ restoredFrom?: string | null;
371
+ /** Optional meta site id */
372
+ metaSiteId?: string | null;
373
+ /** Date that this version was updated (same as created) */
374
+ updateDate?: string;
375
+ /** determine whether this site uses responsive editor */
376
+ isResponsive?: boolean;
377
+ /** optional branch id if revision saved on branch */
378
+ branchId?: string | null;
379
+ /** determine if the new revision is a result of override save */
380
+ overrideSave?: boolean;
381
+ /** Optional last transaction id */
382
+ lastTransactionId?: string | null;
383
+ /** optional branch id if revision restored from branch */
384
+ restoredFromBranchId?: string | null;
385
+ /** information of revision prior to save revision operation */
386
+ lastRevisionInfo?: RevisionInfo;
387
+ /** new revision pages */
388
+ pages?: Page[];
389
+ /** the pages that were changed from the last save. Operations such as clone and restore will return an empty response at the moment. */
390
+ changedPages?: ChangedPages;
391
+ /** id of the main page of the site */
392
+ mainPageId?: string;
393
+ }
394
+ interface RevisionInfo {
395
+ /** revision number */
396
+ revision?: string;
397
+ /** last_transaction_id of revision */
398
+ lastTransactionId?: string | null;
399
+ }
400
+ interface Page {
401
+ /** Page's Id */
402
+ _id?: string;
403
+ }
404
+ interface ChangedPages {
405
+ /** list of updated_pages */
406
+ updatedPages?: Page[];
407
+ /** list of deleted_pages */
408
+ deletedPages?: Page[];
409
+ }
410
+ interface SyncEditorDataRequest {
411
+ /** an optional filter for syncing the content */
412
+ syncFilter?: SyncFilter;
413
+ }
414
+ interface SyncFilter {
415
+ /** content IETF BCP 47 language tag */
416
+ languageTag?: string;
417
+ }
418
+ interface SyncEditorDataResponse {
419
+ }
420
+ interface PublishSiteTranslationsRequest {
421
+ /** A language to publish it's language */
422
+ language?: string;
423
+ }
424
+ interface PublishSiteTranslationsResponse {
425
+ }
426
+ interface V1CreateOrUpdateMapperRequest {
427
+ /** A mapper to create or update if already exist */
428
+ mapper?: Mapper;
429
+ }
430
+ interface V1CreateOrUpdateMapperResponse {
431
+ }
432
+ interface GetMapperRequest {
433
+ /** The mapper type requested */
434
+ entityType?: string;
435
+ }
436
+ interface GetMapperResponse {
437
+ /** The mapper with the entity type requested */
438
+ mapper?: Mapper;
439
+ }
440
+ interface DeleteMapperRequest {
441
+ /** The entity type to delete from the service */
442
+ entityType?: string;
443
+ }
444
+ interface DeleteMapperResponse {
445
+ }
446
+ interface ListMappersRequest {
447
+ }
448
+ interface ListMappersResponse {
449
+ /** all mappers known to editor adapter */
450
+ mappers?: Mapper[];
451
+ }
452
+ interface StressDMRequest {
453
+ /** the meta site id to stress */
454
+ metaSiteId?: string;
455
+ }
456
+ interface StressDMResponse {
457
+ }
458
+ interface SyncEditorDataOptions {
459
+ /** an optional filter for syncing the content */
460
+ syncFilter?: SyncFilter;
461
+ }
462
+
463
+ declare function syncEditorData$1(httpClient: HttpClient): SyncEditorDataSignature;
464
+ interface SyncEditorDataSignature {
465
+ /**
466
+ * Update localization content with editor data
467
+ */
468
+ (options?: SyncEditorDataOptions | undefined): Promise<void>;
469
+ }
470
+
471
+ declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
472
+
473
+ type _publicSyncEditorDataType = typeof syncEditorData$1;
474
+ declare const syncEditorData: ReturnType<typeof createRESTModule$5<_publicSyncEditorDataType>>;
475
+
476
+ type context$5_ChangedPages = ChangedPages;
477
+ type context$5_CreateOrUpdateAction = CreateOrUpdateAction;
478
+ type context$5_CreateOrUpdateMapperRequest = CreateOrUpdateMapperRequest;
479
+ type context$5_CreateOrUpdateMapperResponse = CreateOrUpdateMapperResponse;
480
+ type context$5_DeleteAction = DeleteAction;
481
+ type context$5_DeleteEntityMapperRequest = DeleteEntityMapperRequest;
482
+ type context$5_DeleteEntityMapperResponse = DeleteEntityMapperResponse;
483
+ type context$5_DeleteMapperRequest = DeleteMapperRequest;
484
+ type context$5_DeleteMapperResponse = DeleteMapperResponse;
485
+ type context$5_FieldSequence = FieldSequence;
486
+ type context$5_GetEntityMapperRequest = GetEntityMapperRequest;
487
+ type context$5_GetEntityMapperResponse = GetEntityMapperResponse;
488
+ type context$5_GetMapperRequest = GetMapperRequest;
489
+ type context$5_GetMapperResponse = GetMapperResponse;
490
+ type context$5_GetSubscribedTopicsRequest = GetSubscribedTopicsRequest;
491
+ type context$5_GetSubscribedTopicsResponse = GetSubscribedTopicsResponse;
492
+ type context$5_HtmlNewRevisionSavedMessage = HtmlNewRevisionSavedMessage;
493
+ type context$5_ListMappersRequest = ListMappersRequest;
494
+ type context$5_ListMappersResponse = ListMappersResponse;
495
+ type context$5_LocalizationPublicAction = LocalizationPublicAction;
496
+ type context$5_LocalizationPublicActionActionOneOf = LocalizationPublicActionActionOneOf;
497
+ type context$5_LocalizedContentKey = LocalizedContentKey;
498
+ type context$5_LocalizedPublishedContent = LocalizedPublishedContent;
499
+ type context$5_LocalizedPublishedContentField = LocalizedPublishedContentField;
500
+ type context$5_LocalizedPublishedContentFieldValueOneOf = LocalizedPublishedContentFieldValueOneOf;
501
+ type context$5_LocalizedPublishedLanguageContentChanged = LocalizedPublishedLanguageContentChanged;
502
+ type context$5_Mapper = Mapper;
503
+ type context$5_MapperField = MapperField;
504
+ type context$5_MediaItem = MediaItem;
505
+ type context$5_MediaItemMediaOneOf = MediaItemMediaOneOf;
506
+ type context$5_Page = Page;
507
+ type context$5_PublishSiteTranslationsRequest = PublishSiteTranslationsRequest;
508
+ type context$5_PublishSiteTranslationsResponse = PublishSiteTranslationsResponse;
509
+ type context$5_RevisionInfo = RevisionInfo;
510
+ type context$5_SequencePath = SequencePath;
511
+ type context$5_StressDMRequest = StressDMRequest;
512
+ type context$5_StressDMResponse = StressDMResponse;
513
+ type context$5_SyncEditorDataOptions = SyncEditorDataOptions;
514
+ type context$5_SyncEditorDataRequest = SyncEditorDataRequest;
515
+ type context$5_SyncEditorDataResponse = SyncEditorDataResponse;
516
+ type context$5_SyncFilter = SyncFilter;
517
+ type context$5_V1CreateOrUpdateMapperRequest = V1CreateOrUpdateMapperRequest;
518
+ type context$5_V1CreateOrUpdateMapperResponse = V1CreateOrUpdateMapperResponse;
519
+ type context$5__publicSyncEditorDataType = _publicSyncEditorDataType;
520
+ declare const context$5_syncEditorData: typeof syncEditorData;
521
+ declare namespace context$5 {
522
+ export { type ActionEvent$3 as ActionEvent, type context$5_ChangedPages as ChangedPages, type context$5_CreateOrUpdateAction as CreateOrUpdateAction, type context$5_CreateOrUpdateMapperRequest as CreateOrUpdateMapperRequest, type context$5_CreateOrUpdateMapperResponse as CreateOrUpdateMapperResponse, type context$5_DeleteAction as DeleteAction, type context$5_DeleteEntityMapperRequest as DeleteEntityMapperRequest, type context$5_DeleteEntityMapperResponse as DeleteEntityMapperResponse, type context$5_DeleteMapperRequest as DeleteMapperRequest, type context$5_DeleteMapperResponse as DeleteMapperResponse, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type context$5_FieldSequence as FieldSequence, FieldType$1 as FieldType, type context$5_GetEntityMapperRequest as GetEntityMapperRequest, type context$5_GetEntityMapperResponse as GetEntityMapperResponse, type context$5_GetMapperRequest as GetMapperRequest, type context$5_GetMapperResponse as GetMapperResponse, type context$5_GetSubscribedTopicsRequest as GetSubscribedTopicsRequest, type context$5_GetSubscribedTopicsResponse as GetSubscribedTopicsResponse, type context$5_HtmlNewRevisionSavedMessage as HtmlNewRevisionSavedMessage, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type context$5_ListMappersRequest as ListMappersRequest, type context$5_ListMappersResponse as ListMappersResponse, type context$5_LocalizationPublicAction as LocalizationPublicAction, type context$5_LocalizationPublicActionActionOneOf as LocalizationPublicActionActionOneOf, type context$5_LocalizedContentKey as LocalizedContentKey, type context$5_LocalizedPublishedContent as LocalizedPublishedContent, type context$5_LocalizedPublishedContentField as LocalizedPublishedContentField, type context$5_LocalizedPublishedContentFieldValueOneOf as LocalizedPublishedContentFieldValueOneOf, type context$5_LocalizedPublishedLanguageContentChanged as LocalizedPublishedLanguageContentChanged, type context$5_Mapper as Mapper, type context$5_MapperField as MapperField, type context$5_MediaItem as MediaItem, type context$5_MediaItemMediaOneOf as MediaItemMediaOneOf, type MessageEnvelope$3 as MessageEnvelope, type context$5_Page as Page, type context$5_PublishSiteTranslationsRequest as PublishSiteTranslationsRequest, type context$5_PublishSiteTranslationsResponse as PublishSiteTranslationsResponse, type RestoreInfo$3 as RestoreInfo, type context$5_RevisionInfo as RevisionInfo, type SchemaKey$2 as SchemaKey, SchemaScope$2 as SchemaScope, type context$5_SequencePath as SequencePath, type context$5_StressDMRequest as StressDMRequest, type context$5_StressDMResponse as StressDMResponse, type context$5_SyncEditorDataOptions as SyncEditorDataOptions, type context$5_SyncEditorDataRequest as SyncEditorDataRequest, type context$5_SyncEditorDataResponse as SyncEditorDataResponse, type context$5_SyncFilter as SyncFilter, type context$5_V1CreateOrUpdateMapperRequest as V1CreateOrUpdateMapperRequest, type context$5_V1CreateOrUpdateMapperResponse as V1CreateOrUpdateMapperResponse, type VideoResolution$2 as VideoResolution, WebhookIdentityType$3 as WebhookIdentityType, type context$5__publicSyncEditorDataType as _publicSyncEditorDataType, context$5_syncEditorData as syncEditorData };
523
+ }
524
+
525
+ /** Represents a content of an entity with its published translations */
526
+ interface PublishedContent {
527
+ /**
528
+ * Content ID.
529
+ * @readonly
530
+ */
531
+ _id?: string | null;
532
+ /** Schema key of the content. */
533
+ schemaKey?: SchemaKey$1;
534
+ /**
535
+ * Unique identifier that represents a specific entity under the schema key
536
+ * @readonly
537
+ */
538
+ entityId?: string;
539
+ /**
540
+ * Indicates the locale of this content
541
+ * @readonly
542
+ */
543
+ locale?: string;
544
+ /** List of fields localized in the given locale */
545
+ fields?: PublishedContentField[];
546
+ /** Optional field for the ID of the parent of this entity. */
547
+ parentEntityId?: string | null;
548
+ extendedFields?: ExtendedFields;
549
+ }
550
+ interface SchemaKey$1 {
551
+ /**
552
+ * ID of app that created the schema.
553
+ * @readonly
554
+ */
555
+ appId?: string;
556
+ /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
557
+ entityType?: string;
558
+ /** Scope schema is defined in (Global/Site) */
559
+ scope?: SchemaScope$1;
560
+ }
561
+ declare enum SchemaScope$1 {
562
+ UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
563
+ /** Global schema, relevant to all sites */
564
+ GLOBAL = "GLOBAL",
565
+ /** Site schema, relevant to specific site only */
566
+ SITE = "SITE"
567
+ }
568
+ interface PublishedContentField extends PublishedContentFieldValueOneOf {
569
+ /** Plain text value */
570
+ textValue?: string;
571
+ /** Rich content value */
572
+ richContent?: RichContent$2;
573
+ /** Image media item */
574
+ image?: string;
575
+ /** Video media item */
576
+ video?: string;
577
+ /** Document media item */
578
+ document?: string;
579
+ /**
580
+ * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
581
+ * @readonly
582
+ */
583
+ schemaFieldKey?: string;
584
+ /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
585
+ sequenceIds?: string[];
586
+ }
587
+ /** @oneof */
588
+ interface PublishedContentFieldValueOneOf {
589
+ /** Plain text value */
590
+ textValue?: string;
591
+ /** Rich content value */
592
+ richContent?: RichContent$2;
593
+ /** Image media item */
594
+ image?: string;
595
+ /** Video media item */
596
+ video?: string;
597
+ /** Document media item */
598
+ document?: string;
599
+ }
600
+ interface RichContent$2 {
601
+ /** Node objects representing a rich content document. */
602
+ nodes?: Node$2[];
603
+ /** Object metadata. */
604
+ metadata?: Metadata$2;
605
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
606
+ documentStyle?: DocumentStyle$2;
607
+ }
608
+ interface Node$2 extends NodeDataOneOf$2 {
609
+ /** Data for a button node. */
610
+ buttonData?: ButtonData$2;
611
+ /** Data for a code block node. */
612
+ codeBlockData?: CodeBlockData$2;
613
+ /** Data for a divider node. */
614
+ dividerData?: DividerData$2;
615
+ /** Data for a file node. */
616
+ fileData?: FileData$2;
617
+ /** Data for a gallery node. */
618
+ galleryData?: GalleryData$2;
619
+ /** Data for a GIF node. */
620
+ gifData?: GIFData$2;
621
+ /** Data for a heading node. */
622
+ headingData?: HeadingData$2;
623
+ /** Data for an embedded HTML node. */
624
+ htmlData?: HTMLData$2;
625
+ /** Data for an image node. */
626
+ imageData?: ImageData$2;
627
+ /** Data for a link preview node. */
628
+ linkPreviewData?: LinkPreviewData$2;
629
+ /** Data for a map node. */
630
+ mapData?: MapData$2;
631
+ /** Data for a paragraph node. */
632
+ paragraphData?: ParagraphData$2;
633
+ /** Data for a poll node. */
634
+ pollData?: PollData$2;
635
+ /** Data for a text node. Used to apply decorations to text. */
636
+ textData?: TextData$2;
637
+ /** Data for an app embed node. */
638
+ appEmbedData?: AppEmbedData$2;
639
+ /** Data for a video node. */
640
+ videoData?: VideoData$2;
641
+ /** Data for an oEmbed node. */
642
+ embedData?: EmbedData$2;
643
+ /** Data for a collapsible list node. */
644
+ collapsibleListData?: CollapsibleListData$2;
645
+ /** Data for a table node. */
646
+ tableData?: TableData$2;
647
+ /** Data for a table cell node. */
648
+ tableCellData?: TableCellData$2;
649
+ /** Data for a custom external node. */
650
+ externalData?: Record<string, any> | null;
651
+ /** Data for an audio node. */
652
+ audioData?: AudioData$2;
653
+ /** Data for an ordered list node. */
654
+ orderedListData?: OrderedListData$2;
655
+ /** Data for a bulleted list node. */
656
+ bulletedListData?: BulletedListData$2;
657
+ /** Data for a block quote node. */
658
+ blockquoteData?: BlockquoteData$2;
659
+ /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
660
+ type?: NodeType$2;
661
+ /** Node ID. */
662
+ _id?: string;
663
+ /** A list of child nodes. */
664
+ nodes?: Node$2[];
665
+ /** Padding and background color styling for the node. */
666
+ style?: NodeStyle$2;
667
+ }
668
+ /** @oneof */
669
+ interface NodeDataOneOf$2 {
670
+ /** Data for a button node. */
671
+ buttonData?: ButtonData$2;
672
+ /** Data for a code block node. */
673
+ codeBlockData?: CodeBlockData$2;
674
+ /** Data for a divider node. */
675
+ dividerData?: DividerData$2;
676
+ /** Data for a file node. */
677
+ fileData?: FileData$2;
678
+ /** Data for a gallery node. */
679
+ galleryData?: GalleryData$2;
680
+ /** Data for a GIF node. */
681
+ gifData?: GIFData$2;
682
+ /** Data for a heading node. */
683
+ headingData?: HeadingData$2;
684
+ /** Data for an embedded HTML node. */
685
+ htmlData?: HTMLData$2;
686
+ /** Data for an image node. */
687
+ imageData?: ImageData$2;
688
+ /** Data for a link preview node. */
689
+ linkPreviewData?: LinkPreviewData$2;
690
+ /** Data for a map node. */
691
+ mapData?: MapData$2;
692
+ /** Data for a paragraph node. */
693
+ paragraphData?: ParagraphData$2;
694
+ /** Data for a poll node. */
695
+ pollData?: PollData$2;
696
+ /** Data for a text node. Used to apply decorations to text. */
697
+ textData?: TextData$2;
698
+ /** Data for an app embed node. */
699
+ appEmbedData?: AppEmbedData$2;
700
+ /** Data for a video node. */
701
+ videoData?: VideoData$2;
702
+ /** Data for an oEmbed node. */
703
+ embedData?: EmbedData$2;
704
+ /** Data for a collapsible list node. */
705
+ collapsibleListData?: CollapsibleListData$2;
706
+ /** Data for a table node. */
707
+ tableData?: TableData$2;
708
+ /** Data for a table cell node. */
709
+ tableCellData?: TableCellData$2;
710
+ /** Data for a custom external node. */
711
+ externalData?: Record<string, any> | null;
712
+ /** Data for an audio node. */
713
+ audioData?: AudioData$2;
714
+ /** Data for an ordered list node. */
715
+ orderedListData?: OrderedListData$2;
716
+ /** Data for a bulleted list node. */
717
+ bulletedListData?: BulletedListData$2;
718
+ /** Data for a block quote node. */
719
+ blockquoteData?: BlockquoteData$2;
720
+ }
721
+ declare enum NodeType$2 {
722
+ PARAGRAPH = "PARAGRAPH",
723
+ TEXT = "TEXT",
724
+ HEADING = "HEADING",
725
+ BULLETED_LIST = "BULLETED_LIST",
726
+ ORDERED_LIST = "ORDERED_LIST",
727
+ LIST_ITEM = "LIST_ITEM",
728
+ BLOCKQUOTE = "BLOCKQUOTE",
729
+ CODE_BLOCK = "CODE_BLOCK",
730
+ VIDEO = "VIDEO",
731
+ DIVIDER = "DIVIDER",
732
+ FILE = "FILE",
733
+ GALLERY = "GALLERY",
734
+ GIF = "GIF",
735
+ HTML = "HTML",
736
+ IMAGE = "IMAGE",
737
+ LINK_PREVIEW = "LINK_PREVIEW",
738
+ MAP = "MAP",
739
+ POLL = "POLL",
740
+ APP_EMBED = "APP_EMBED",
741
+ BUTTON = "BUTTON",
742
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
743
+ TABLE = "TABLE",
744
+ EMBED = "EMBED",
745
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
746
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
747
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
748
+ TABLE_CELL = "TABLE_CELL",
749
+ TABLE_ROW = "TABLE_ROW",
750
+ EXTERNAL = "EXTERNAL",
751
+ AUDIO = "AUDIO"
752
+ }
753
+ interface NodeStyle$2 {
754
+ /** The top padding value in pixels. */
755
+ paddingTop?: string | null;
756
+ /** The bottom padding value in pixels. */
757
+ paddingBottom?: string | null;
758
+ /** The background color as a hexadecimal value. */
759
+ backgroundColor?: string | null;
760
+ }
761
+ interface ButtonData$2 {
762
+ /** Styling for the button's container. */
763
+ containerData?: PluginContainerData$2;
764
+ /** The button type. */
765
+ type?: Type$2;
766
+ /** Styling for the button. */
767
+ styles?: Styles$2;
768
+ /** The text to display on the button. */
769
+ text?: string | null;
770
+ /** Button link details. */
771
+ link?: Link$2;
772
+ }
773
+ interface Border$2 {
774
+ /** Border width in pixels. */
775
+ width?: number | null;
776
+ /** Border radius in pixels. */
777
+ radius?: number | null;
778
+ }
779
+ interface Colors$2 {
780
+ /** The text color as a hexadecimal value. */
781
+ text?: string | null;
782
+ /** The border color as a hexadecimal value. */
783
+ border?: string | null;
784
+ /** The background color as a hexadecimal value. */
785
+ background?: string | null;
786
+ }
787
+ interface PluginContainerData$2 {
788
+ /** The width of the node when it's displayed. */
789
+ width?: PluginContainerDataWidth$2;
790
+ /** The node's alignment within its container. */
791
+ alignment?: PluginContainerDataAlignment$2;
792
+ /** Spoiler cover settings for the node. */
793
+ spoiler?: Spoiler$2;
794
+ /** The height of the node when it's displayed. */
795
+ height?: Height$2;
796
+ /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
797
+ textWrap?: boolean | null;
798
+ }
799
+ declare enum WidthType$2 {
800
+ /** Width matches the content width */
801
+ CONTENT = "CONTENT",
802
+ /** Small Width */
803
+ SMALL = "SMALL",
804
+ /** Width will match the original asset width */
805
+ ORIGINAL = "ORIGINAL",
806
+ /** coast-to-coast display */
807
+ FULL_WIDTH = "FULL_WIDTH"
808
+ }
809
+ interface PluginContainerDataWidth$2 extends PluginContainerDataWidthDataOneOf$2 {
810
+ /**
811
+ * One of the following predefined width options:
812
+ * `CONTENT`: The width of the container matches the content width.
813
+ * `SMALL`: A small width.
814
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
815
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
816
+ */
817
+ size?: WidthType$2;
818
+ /** A custom width value in pixels. */
819
+ custom?: string | null;
820
+ }
821
+ /** @oneof */
822
+ interface PluginContainerDataWidthDataOneOf$2 {
823
+ /**
824
+ * One of the following predefined width options:
825
+ * `CONTENT`: The width of the container matches the content width.
826
+ * `SMALL`: A small width.
827
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
828
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
829
+ */
830
+ size?: WidthType$2;
831
+ /** A custom width value in pixels. */
832
+ custom?: string | null;
833
+ }
834
+ declare enum PluginContainerDataAlignment$2 {
835
+ /** Center Alignment */
836
+ CENTER = "CENTER",
837
+ /** Left Alignment */
838
+ LEFT = "LEFT",
839
+ /** Right Alignment */
840
+ RIGHT = "RIGHT"
841
+ }
842
+ interface Spoiler$2 {
843
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
844
+ enabled?: boolean | null;
845
+ /** The description displayed on top of the spoiler cover. */
846
+ description?: string | null;
847
+ /** The text for the button used to remove the spoiler cover. */
848
+ buttonText?: string | null;
849
+ }
850
+ interface Height$2 {
851
+ /** A custom height value in pixels. */
852
+ custom?: string | null;
853
+ }
854
+ declare enum Type$2 {
855
+ /** Regular link button */
856
+ LINK = "LINK",
857
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
858
+ ACTION = "ACTION"
859
+ }
860
+ interface Styles$2 {
861
+ /** Border attributes. */
862
+ border?: Border$2;
863
+ /** Color attributes. */
864
+ colors?: Colors$2;
865
+ }
866
+ interface Link$2 extends LinkDataOneOf$2 {
867
+ /** The absolute URL for the linked document. */
868
+ url?: string;
869
+ /** The target node's ID. Used for linking to another node in this object. */
870
+ anchor?: string;
871
+ /**
872
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
873
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
874
+ * `BLANK` - Opens the linked document in a new browser tab or window.
875
+ * `PARENT` - Opens the linked document in the link's parent frame.
876
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
877
+ */
878
+ target?: Target$2;
879
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
880
+ rel?: Rel$2;
881
+ /** A serialized object used for a custom or external link panel. */
882
+ customData?: string | null;
883
+ }
884
+ /** @oneof */
885
+ interface LinkDataOneOf$2 {
886
+ /** The absolute URL for the linked document. */
887
+ url?: string;
888
+ /** The target node's ID. Used for linking to another node in this object. */
889
+ anchor?: string;
890
+ }
891
+ declare enum Target$2 {
892
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
893
+ SELF = "SELF",
894
+ /** Opens the linked document in a new window or tab */
895
+ BLANK = "BLANK",
896
+ /** Opens the linked document in the parent frame */
897
+ PARENT = "PARENT",
898
+ /** Opens the linked document in the full body of the window */
899
+ TOP = "TOP"
900
+ }
901
+ interface Rel$2 {
902
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
903
+ nofollow?: boolean | null;
904
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
905
+ sponsored?: boolean | null;
906
+ /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
907
+ ugc?: boolean | null;
908
+ /** Indicates that this link protect referral information from being passed to the target website. */
909
+ noreferrer?: boolean | null;
910
+ }
911
+ interface CodeBlockData$2 {
912
+ /** Styling for the code block's text. */
913
+ textStyle?: TextStyle$2;
914
+ }
915
+ interface TextStyle$2 {
916
+ /** Text alignment. Defaults to `AUTO`. */
917
+ textAlignment?: TextAlignment$2;
918
+ /** 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. */
919
+ lineHeight?: string | null;
920
+ }
921
+ declare enum TextAlignment$2 {
922
+ /** browser default, eqivalent to `initial` */
923
+ AUTO = "AUTO",
924
+ /** Left align */
925
+ LEFT = "LEFT",
926
+ /** Right align */
927
+ RIGHT = "RIGHT",
928
+ /** Center align */
929
+ CENTER = "CENTER",
930
+ /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
931
+ JUSTIFY = "JUSTIFY"
932
+ }
933
+ interface DividerData$2 {
934
+ /** Styling for the divider's container. */
935
+ containerData?: PluginContainerData$2;
936
+ /** Divider line style. */
937
+ lineStyle?: LineStyle$2;
938
+ /** Divider width. */
939
+ width?: Width$2;
940
+ /** Divider alignment. */
941
+ alignment?: Alignment$2;
942
+ }
943
+ declare enum LineStyle$2 {
944
+ /** Single Line */
945
+ SINGLE = "SINGLE",
946
+ /** Double Line */
947
+ DOUBLE = "DOUBLE",
948
+ /** Dashed Line */
949
+ DASHED = "DASHED",
950
+ /** Dotted Line */
951
+ DOTTED = "DOTTED"
952
+ }
953
+ declare enum Width$2 {
954
+ /** Large line */
955
+ LARGE = "LARGE",
956
+ /** Medium line */
957
+ MEDIUM = "MEDIUM",
958
+ /** Small line */
959
+ SMALL = "SMALL"
960
+ }
961
+ declare enum Alignment$2 {
962
+ /** Center alignment */
963
+ CENTER = "CENTER",
964
+ /** Left alignment */
965
+ LEFT = "LEFT",
966
+ /** Right alignment */
967
+ RIGHT = "RIGHT"
968
+ }
969
+ interface FileData$2 {
970
+ /** Styling for the file's container. */
971
+ containerData?: PluginContainerData$2;
972
+ /** The source for the file's data. */
973
+ src?: FileSource$2;
974
+ /** File name. */
975
+ name?: string | null;
976
+ /** File type. */
977
+ type?: string | null;
978
+ /**
979
+ * Use `sizeInKb` instead.
980
+ * @deprecated
981
+ */
982
+ size?: number | null;
983
+ /** Settings for PDF files. */
984
+ pdfSettings?: PDFSettings$2;
985
+ /** File MIME type. */
986
+ mimeType?: string | null;
987
+ /** File path. */
988
+ path?: string | null;
989
+ /** File size in KB. */
990
+ sizeInKb?: string | null;
991
+ }
992
+ declare enum ViewMode$2 {
993
+ /** No PDF view */
994
+ NONE = "NONE",
995
+ /** Full PDF view */
996
+ FULL = "FULL",
997
+ /** Mini PDF view */
998
+ MINI = "MINI"
999
+ }
1000
+ interface FileSource$2 extends FileSourceDataOneOf$2 {
1001
+ /** The absolute URL for the file's source. */
1002
+ url?: string | null;
1003
+ /**
1004
+ * Custom ID. Use `id` instead.
1005
+ * @deprecated
1006
+ */
1007
+ custom?: string | null;
1008
+ /** An ID that's resolved to a URL by a resolver function. */
1009
+ _id?: string | null;
1010
+ /** Indicates whether the file's source is private. Defaults to `false`. */
1011
+ private?: boolean | null;
1012
+ }
1013
+ /** @oneof */
1014
+ interface FileSourceDataOneOf$2 {
1015
+ /** The absolute URL for the file's source. */
1016
+ url?: string | null;
1017
+ /**
1018
+ * Custom ID. Use `id` instead.
1019
+ * @deprecated
1020
+ */
1021
+ custom?: string | null;
1022
+ /** An ID that's resolved to a URL by a resolver function. */
1023
+ _id?: string | null;
1024
+ }
1025
+ interface PDFSettings$2 {
1026
+ /**
1027
+ * PDF view mode. One of the following:
1028
+ * `NONE` : The PDF isn't displayed.
1029
+ * `FULL` : A full page view of the PDF is displayed.
1030
+ * `MINI` : A mini view of the PDF is displayed.
1031
+ */
1032
+ viewMode?: ViewMode$2;
1033
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
1034
+ disableDownload?: boolean | null;
1035
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
1036
+ disablePrint?: boolean | null;
1037
+ }
1038
+ interface GalleryData$2 {
1039
+ /** Styling for the gallery's container. */
1040
+ containerData?: PluginContainerData$2;
1041
+ /** The items in the gallery. */
1042
+ items?: Item$2[];
1043
+ /** Options for defining the gallery's appearance. */
1044
+ options?: GalleryOptions$2;
1045
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
1046
+ disableExpand?: boolean | null;
1047
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
1048
+ disableDownload?: boolean | null;
1049
+ }
1050
+ interface Media$2 {
1051
+ /** The source for the media's data. */
1052
+ src?: FileSource$2;
1053
+ /** Media width in pixels. */
1054
+ width?: number | null;
1055
+ /** Media height in pixels. */
1056
+ height?: number | null;
1057
+ /** Media duration in seconds. Only relevant for audio and video files. */
1058
+ duration?: number | null;
1059
+ }
1060
+ interface Image$2 {
1061
+ /** Image file details. */
1062
+ media?: Media$2;
1063
+ /** Link details for images that are links. */
1064
+ link?: Link$2;
1065
+ }
1066
+ interface Video$2 {
1067
+ /** Video file details. */
1068
+ media?: Media$2;
1069
+ /** Video thumbnail file details. */
1070
+ thumbnail?: Media$2;
1071
+ }
1072
+ interface Item$2 extends ItemDataOneOf$2 {
1073
+ /** An image item. */
1074
+ image?: Image$2;
1075
+ /** A video item. */
1076
+ video?: Video$2;
1077
+ /** Item title. */
1078
+ title?: string | null;
1079
+ /** Item's alternative text. */
1080
+ altText?: string | null;
1081
+ }
1082
+ /** @oneof */
1083
+ interface ItemDataOneOf$2 {
1084
+ /** An image item. */
1085
+ image?: Image$2;
1086
+ /** A video item. */
1087
+ video?: Video$2;
1088
+ }
1089
+ interface GalleryOptions$2 {
1090
+ /** Gallery layout. */
1091
+ layout?: Layout$2;
1092
+ /** Styling for gallery items. */
1093
+ item?: ItemStyle$2;
1094
+ /** Styling for gallery thumbnail images. */
1095
+ thumbnails?: Thumbnails$2;
1096
+ }
1097
+ declare enum LayoutType$2 {
1098
+ /** Collage type */
1099
+ COLLAGE = "COLLAGE",
1100
+ /** Masonry type */
1101
+ MASONRY = "MASONRY",
1102
+ /** Grid type */
1103
+ GRID = "GRID",
1104
+ /** Thumbnail type */
1105
+ THUMBNAIL = "THUMBNAIL",
1106
+ /** Slider type */
1107
+ SLIDER = "SLIDER",
1108
+ /** Slideshow type */
1109
+ SLIDESHOW = "SLIDESHOW",
1110
+ /** Panorama type */
1111
+ PANORAMA = "PANORAMA",
1112
+ /** Column type */
1113
+ COLUMN = "COLUMN",
1114
+ /** Magic type */
1115
+ MAGIC = "MAGIC",
1116
+ /** Fullsize images type */
1117
+ FULLSIZE = "FULLSIZE"
1118
+ }
1119
+ declare enum Orientation$2 {
1120
+ /** Rows Orientation */
1121
+ ROWS = "ROWS",
1122
+ /** Columns Orientation */
1123
+ COLUMNS = "COLUMNS"
1124
+ }
1125
+ declare enum Crop$2 {
1126
+ /** Crop to fill */
1127
+ FILL = "FILL",
1128
+ /** Crop to fit */
1129
+ FIT = "FIT"
1130
+ }
1131
+ declare enum ThumbnailsAlignment$2 {
1132
+ /** Top alignment */
1133
+ TOP = "TOP",
1134
+ /** Right alignment */
1135
+ RIGHT = "RIGHT",
1136
+ /** Bottom alignment */
1137
+ BOTTOM = "BOTTOM",
1138
+ /** Left alignment */
1139
+ LEFT = "LEFT",
1140
+ /** No thumbnail */
1141
+ NONE = "NONE"
1142
+ }
1143
+ interface Layout$2 {
1144
+ /** Gallery layout type. */
1145
+ type?: LayoutType$2;
1146
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
1147
+ horizontalScroll?: boolean | null;
1148
+ /** Gallery orientation. */
1149
+ orientation?: Orientation$2;
1150
+ /** The number of columns to display on full size screens. */
1151
+ numberOfColumns?: number | null;
1152
+ /** The number of columns to display on mobile screens. */
1153
+ mobileNumberOfColumns?: number | null;
1154
+ }
1155
+ interface ItemStyle$2 {
1156
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
1157
+ targetSize?: number | null;
1158
+ /** Item ratio */
1159
+ ratio?: number | null;
1160
+ /** Sets how item images are cropped. */
1161
+ crop?: Crop$2;
1162
+ /** The spacing between items in pixels. */
1163
+ spacing?: number | null;
1164
+ }
1165
+ interface Thumbnails$2 {
1166
+ /** Thumbnail alignment. */
1167
+ placement?: ThumbnailsAlignment$2;
1168
+ /** Spacing between thumbnails in pixels. */
1169
+ spacing?: number | null;
1170
+ }
1171
+ interface GIFData$2 {
1172
+ /** Styling for the GIF's container. */
1173
+ containerData?: PluginContainerData$2;
1174
+ /** The source of the full size GIF. */
1175
+ original?: GIF$2;
1176
+ /** The source of the downsized GIF. */
1177
+ downsized?: GIF$2;
1178
+ /** Height in pixels. */
1179
+ height?: number;
1180
+ /** Width in pixels. */
1181
+ width?: number;
1182
+ }
1183
+ interface GIF$2 {
1184
+ /** GIF format URL. */
1185
+ gif?: string | null;
1186
+ /** MP4 format URL. */
1187
+ mp4?: string | null;
1188
+ /** Thumbnail URL. */
1189
+ still?: string | null;
1190
+ }
1191
+ interface HeadingData$2 {
1192
+ /** Heading level from 1-6. */
1193
+ level?: number;
1194
+ /** Styling for the heading text. */
1195
+ textStyle?: TextStyle$2;
1196
+ /** Indentation level from 1-4. */
1197
+ indentation?: number | null;
1198
+ }
1199
+ interface HTMLData$2 extends HTMLDataDataOneOf$2 {
1200
+ /** The URL for the HTML code for the node. */
1201
+ url?: string;
1202
+ /** The HTML code for the node. */
1203
+ html?: string;
1204
+ /**
1205
+ * Whether this is an AdSense element. Use `source` instead.
1206
+ * @deprecated
1207
+ */
1208
+ isAdsense?: boolean | null;
1209
+ /** Styling for the HTML node's container. */
1210
+ containerData?: PluginContainerData$2;
1211
+ /** The type of HTML code. */
1212
+ source?: Source$2;
1213
+ }
1214
+ /** @oneof */
1215
+ interface HTMLDataDataOneOf$2 {
1216
+ /** The URL for the HTML code for the node. */
1217
+ url?: string;
1218
+ /** The HTML code for the node. */
1219
+ html?: string;
1220
+ /**
1221
+ * Whether this is an AdSense element. Use `source` instead.
1222
+ * @deprecated
1223
+ */
1224
+ isAdsense?: boolean | null;
1225
+ }
1226
+ declare enum Source$2 {
1227
+ HTML = "HTML",
1228
+ ADSENSE = "ADSENSE"
1229
+ }
1230
+ interface ImageData$2 {
1231
+ /** Styling for the image's container. */
1232
+ containerData?: PluginContainerData$2;
1233
+ /** Image file details. */
1234
+ image?: Media$2;
1235
+ /** Link details for images that are links. */
1236
+ link?: Link$2;
1237
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
1238
+ disableExpand?: boolean | null;
1239
+ /** Image's alternative text. */
1240
+ altText?: string | null;
1241
+ /** Image caption. */
1242
+ caption?: string | null;
1243
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
1244
+ disableDownload?: boolean | null;
1245
+ }
1246
+ interface LinkPreviewData$2 {
1247
+ /** Styling for the link preview's container. */
1248
+ containerData?: PluginContainerData$2;
1249
+ /** Link details. */
1250
+ link?: Link$2;
1251
+ /** Preview title. */
1252
+ title?: string | null;
1253
+ /** Preview thumbnail URL. */
1254
+ thumbnailUrl?: string | null;
1255
+ /** Preview description. */
1256
+ description?: string | null;
1257
+ /** The preview content as HTML. */
1258
+ html?: string | null;
1259
+ }
1260
+ interface MapData$2 {
1261
+ /** Styling for the map's container. */
1262
+ containerData?: PluginContainerData$2;
1263
+ /** Map settings. */
1264
+ mapSettings?: MapSettings$2;
1265
+ }
1266
+ interface MapSettings$2 {
1267
+ /** The address to display on the map. */
1268
+ address?: string | null;
1269
+ /** Sets whether the map is draggable. */
1270
+ draggable?: boolean | null;
1271
+ /** Sets whether the location marker is visible. */
1272
+ marker?: boolean | null;
1273
+ /** Sets whether street view control is enabled. */
1274
+ streetViewControl?: boolean | null;
1275
+ /** Sets whether zoom control is enabled. */
1276
+ zoomControl?: boolean | null;
1277
+ /** Location latitude. */
1278
+ lat?: number | null;
1279
+ /** Location longitude. */
1280
+ lng?: number | null;
1281
+ /** Location name. */
1282
+ locationName?: string | null;
1283
+ /** Sets whether view mode control is enabled. */
1284
+ viewModeControl?: boolean | null;
1285
+ /** Initial zoom value. */
1286
+ initialZoom?: number | null;
1287
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1288
+ mapType?: MapType$2;
1289
+ }
1290
+ declare enum MapType$2 {
1291
+ /** Roadmap map type */
1292
+ ROADMAP = "ROADMAP",
1293
+ /** Satellite map type */
1294
+ SATELITE = "SATELITE",
1295
+ /** Hybrid map type */
1296
+ HYBRID = "HYBRID",
1297
+ /** Terrain map type */
1298
+ TERRAIN = "TERRAIN"
1299
+ }
1300
+ interface ParagraphData$2 {
1301
+ /** Styling for the paragraph text. */
1302
+ textStyle?: TextStyle$2;
1303
+ /** Indentation level from 1-4. */
1304
+ indentation?: number | null;
1305
+ /** Paragraph level */
1306
+ level?: number | null;
1307
+ }
1308
+ interface PollData$2 {
1309
+ /** Styling for the poll's container. */
1310
+ containerData?: PluginContainerData$2;
1311
+ /** Poll data. */
1312
+ poll?: Poll$2;
1313
+ /** Layout settings for the poll and voting options. */
1314
+ layout?: PollDataLayout$2;
1315
+ /** Styling for the poll and voting options. */
1316
+ design?: Design$2;
1317
+ }
1318
+ declare enum ViewRole$2 {
1319
+ /** Only Poll creator can view the results */
1320
+ CREATOR = "CREATOR",
1321
+ /** Anyone who voted can see the results */
1322
+ VOTERS = "VOTERS",
1323
+ /** Anyone can see the results, even if one didn't vote */
1324
+ EVERYONE = "EVERYONE"
1325
+ }
1326
+ declare enum VoteRole$2 {
1327
+ /** Logged in member */
1328
+ SITE_MEMBERS = "SITE_MEMBERS",
1329
+ /** Anyone */
1330
+ ALL = "ALL"
1331
+ }
1332
+ interface Permissions$2 {
1333
+ /** Sets who can view the poll results. */
1334
+ view?: ViewRole$2;
1335
+ /** Sets who can vote. */
1336
+ vote?: VoteRole$2;
1337
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1338
+ allowMultipleVotes?: boolean | null;
1339
+ }
1340
+ interface Option$2 {
1341
+ /** Option ID. */
1342
+ _id?: string | null;
1343
+ /** Option title. */
1344
+ title?: string | null;
1345
+ /** The image displayed with the option. */
1346
+ image?: Media$2;
1347
+ }
1348
+ interface Settings$2 {
1349
+ /** Permissions settings for voting. */
1350
+ permissions?: Permissions$2;
1351
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1352
+ showVoters?: boolean | null;
1353
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
1354
+ showVotesCount?: boolean | null;
1355
+ }
1356
+ declare enum PollLayoutType$2 {
1357
+ /** List */
1358
+ LIST = "LIST",
1359
+ /** Grid */
1360
+ GRID = "GRID"
1361
+ }
1362
+ declare enum PollLayoutDirection$2 {
1363
+ /** Left-to-right */
1364
+ LTR = "LTR",
1365
+ /** Right-to-left */
1366
+ RTL = "RTL"
1367
+ }
1368
+ interface PollLayout$2 {
1369
+ /** The layout for displaying the voting options. */
1370
+ type?: PollLayoutType$2;
1371
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1372
+ direction?: PollLayoutDirection$2;
1373
+ /** Sets whether to display the main poll image. Defaults to `false`. */
1374
+ enableImage?: boolean | null;
1375
+ }
1376
+ interface OptionLayout$2 {
1377
+ /** Sets whether to display option images. Defaults to `false`. */
1378
+ enableImage?: boolean | null;
1379
+ }
1380
+ declare enum BackgroundType$2 {
1381
+ /** Color background type */
1382
+ COLOR = "COLOR",
1383
+ /** Image background type */
1384
+ IMAGE = "IMAGE",
1385
+ /** Gradiant background type */
1386
+ GRADIENT = "GRADIENT"
1387
+ }
1388
+ interface Gradient$2 {
1389
+ /** The gradient angle in degrees. */
1390
+ angle?: number | null;
1391
+ /** The start color as a hexademical value. */
1392
+ startColor?: string | null;
1393
+ /** The end color as a hexademical value. */
1394
+ lastColor?: string | null;
1395
+ }
1396
+ interface Background$2 extends BackgroundBackgroundOneOf$2 {
1397
+ /** The background color as a hexademical value. */
1398
+ color?: string | null;
1399
+ /** An image to use for the background. */
1400
+ image?: Media$2;
1401
+ /** Details for a gradient background. */
1402
+ gradient?: Gradient$2;
1403
+ /** Background type. For each option, include the relevant details. */
1404
+ type?: BackgroundType$2;
1405
+ }
1406
+ /** @oneof */
1407
+ interface BackgroundBackgroundOneOf$2 {
1408
+ /** The background color as a hexademical value. */
1409
+ color?: string | null;
1410
+ /** An image to use for the background. */
1411
+ image?: Media$2;
1412
+ /** Details for a gradient background. */
1413
+ gradient?: Gradient$2;
1414
+ }
1415
+ interface PollDesign$2 {
1416
+ /** Background styling. */
1417
+ background?: Background$2;
1418
+ /** Border radius in pixels. */
1419
+ borderRadius?: number | null;
1420
+ }
1421
+ interface OptionDesign$2 {
1422
+ /** Border radius in pixels. */
1423
+ borderRadius?: number | null;
1424
+ }
1425
+ interface Poll$2 {
1426
+ /** Poll ID. */
1427
+ _id?: string | null;
1428
+ /** Poll title. */
1429
+ title?: string | null;
1430
+ /** Poll creator ID. */
1431
+ creatorId?: string | null;
1432
+ /** Main poll image. */
1433
+ image?: Media$2;
1434
+ /** Voting options. */
1435
+ options?: Option$2[];
1436
+ /** The poll's permissions and display settings. */
1437
+ settings?: Settings$2;
1438
+ }
1439
+ interface PollDataLayout$2 {
1440
+ /** Poll layout settings. */
1441
+ poll?: PollLayout$2;
1442
+ /** Voting otpions layout settings. */
1443
+ options?: OptionLayout$2;
1444
+ }
1445
+ interface Design$2 {
1446
+ /** Styling for the poll. */
1447
+ poll?: PollDesign$2;
1448
+ /** Styling for voting options. */
1449
+ options?: OptionDesign$2;
1450
+ }
1451
+ interface TextData$2 {
1452
+ /** The text to apply decorations to. */
1453
+ text?: string;
1454
+ /** The decorations to apply. */
1455
+ decorations?: Decoration$2[];
1456
+ }
1457
+ /** Adds appearence changes to text */
1458
+ interface Decoration$2 extends DecorationDataOneOf$2 {
1459
+ /** Data for an anchor link decoration. */
1460
+ anchorData?: AnchorData$2;
1461
+ /** Data for a color decoration. */
1462
+ colorData?: ColorData$2;
1463
+ /** Data for an external link decoration. */
1464
+ linkData?: LinkData$2;
1465
+ /** Data for a mention decoration. */
1466
+ mentionData?: MentionData$2;
1467
+ /** Data for a font size decoration. */
1468
+ fontSizeData?: FontSizeData$2;
1469
+ /** Font weight for a bold decoration. */
1470
+ fontWeightValue?: number | null;
1471
+ /** Data for an italic decoration. Defaults to `true`. */
1472
+ italicData?: boolean | null;
1473
+ /** Data for an underline decoration. Defaults to `true`. */
1474
+ underlineData?: boolean | null;
1475
+ /** Data for a spoiler decoration. */
1476
+ spoilerData?: SpoilerData$2;
1477
+ /** The type of decoration to apply. */
1478
+ type?: DecorationType$2;
1479
+ }
1480
+ /** @oneof */
1481
+ interface DecorationDataOneOf$2 {
1482
+ /** Data for an anchor link decoration. */
1483
+ anchorData?: AnchorData$2;
1484
+ /** Data for a color decoration. */
1485
+ colorData?: ColorData$2;
1486
+ /** Data for an external link decoration. */
1487
+ linkData?: LinkData$2;
1488
+ /** Data for a mention decoration. */
1489
+ mentionData?: MentionData$2;
1490
+ /** Data for a font size decoration. */
1491
+ fontSizeData?: FontSizeData$2;
1492
+ /** Font weight for a bold decoration. */
1493
+ fontWeightValue?: number | null;
1494
+ /** Data for an italic decoration. Defaults to `true`. */
1495
+ italicData?: boolean | null;
1496
+ /** Data for an underline decoration. Defaults to `true`. */
1497
+ underlineData?: boolean | null;
1498
+ /** Data for a spoiler decoration. */
1499
+ spoilerData?: SpoilerData$2;
1500
+ }
1501
+ declare enum DecorationType$2 {
1502
+ BOLD = "BOLD",
1503
+ ITALIC = "ITALIC",
1504
+ UNDERLINE = "UNDERLINE",
1505
+ SPOILER = "SPOILER",
1506
+ ANCHOR = "ANCHOR",
1507
+ MENTION = "MENTION",
1508
+ LINK = "LINK",
1509
+ COLOR = "COLOR",
1510
+ FONT_SIZE = "FONT_SIZE",
1511
+ EXTERNAL = "EXTERNAL"
1512
+ }
1513
+ interface AnchorData$2 {
1514
+ /** The target node's ID. */
1515
+ anchor?: string;
1516
+ }
1517
+ interface ColorData$2 {
1518
+ /** The text's background color as a hexadecimal value. */
1519
+ background?: string | null;
1520
+ /** The text's foreground color as a hexadecimal value. */
1521
+ foreground?: string | null;
1522
+ }
1523
+ interface LinkData$2 {
1524
+ /** Link details. */
1525
+ link?: Link$2;
1526
+ }
1527
+ interface MentionData$2 {
1528
+ /** The mentioned user's name. */
1529
+ name?: string;
1530
+ /** The version of the user's name that appears after the `@` character in the mention. */
1531
+ slug?: string;
1532
+ /** Mentioned user's ID. */
1533
+ _id?: string | null;
1534
+ }
1535
+ interface FontSizeData$2 {
1536
+ /** The units used for the font size. */
1537
+ unit?: FontType$2;
1538
+ /** Font size value. */
1539
+ value?: number | null;
1540
+ }
1541
+ declare enum FontType$2 {
1542
+ PX = "PX",
1543
+ EM = "EM"
1544
+ }
1545
+ interface SpoilerData$2 {
1546
+ /** Spoiler ID. */
1547
+ _id?: string | null;
1548
+ }
1549
+ interface AppEmbedData$2 extends AppEmbedDataAppDataOneOf$2 {
1550
+ /** Data for embedded Wix Bookings content. */
1551
+ bookingData?: BookingData$2;
1552
+ /** Data for embedded Wix Events content. */
1553
+ eventData?: EventData$2;
1554
+ /** The type of Wix App content being embedded. */
1555
+ type?: AppType$2;
1556
+ /** The ID of the embedded content. */
1557
+ itemId?: string | null;
1558
+ /** The name of the embedded content. */
1559
+ name?: string | null;
1560
+ /**
1561
+ * Deprecated: Use `image` instead.
1562
+ * @deprecated
1563
+ */
1564
+ imageSrc?: string | null;
1565
+ /** The URL for the embedded content. */
1566
+ url?: string | null;
1567
+ /** An image for the embedded content. */
1568
+ image?: Media$2;
1569
+ }
1570
+ /** @oneof */
1571
+ interface AppEmbedDataAppDataOneOf$2 {
1572
+ /** Data for embedded Wix Bookings content. */
1573
+ bookingData?: BookingData$2;
1574
+ /** Data for embedded Wix Events content. */
1575
+ eventData?: EventData$2;
1576
+ }
1577
+ declare enum AppType$2 {
1578
+ PRODUCT = "PRODUCT",
1579
+ EVENT = "EVENT",
1580
+ BOOKING = "BOOKING"
1581
+ }
1582
+ interface BookingData$2 {
1583
+ /** Booking duration in minutes. */
1584
+ durations?: string | null;
1585
+ }
1586
+ interface EventData$2 {
1587
+ /** Event schedule. */
1588
+ scheduling?: string | null;
1589
+ /** Event location. */
1590
+ location?: string | null;
1591
+ }
1592
+ interface VideoData$2 {
1593
+ /** Styling for the video's container. */
1594
+ containerData?: PluginContainerData$2;
1595
+ /** Video details. */
1596
+ video?: Media$2;
1597
+ /** Video thumbnail details. */
1598
+ thumbnail?: Media$2;
1599
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1600
+ disableDownload?: boolean | null;
1601
+ /** Video title. */
1602
+ title?: string | null;
1603
+ /** Video options. */
1604
+ options?: PlaybackOptions$2;
1605
+ }
1606
+ interface PlaybackOptions$2 {
1607
+ /** Sets whether the media will automatically start playing. */
1608
+ autoPlay?: boolean | null;
1609
+ /** Sets whether media's will be looped. */
1610
+ playInLoop?: boolean | null;
1611
+ /** Sets whether media's controls will be shown. */
1612
+ showControls?: boolean | null;
1613
+ }
1614
+ interface EmbedData$2 {
1615
+ /** Styling for the oEmbed node's container. */
1616
+ containerData?: PluginContainerData$2;
1617
+ /** An [oEmbed](https://www.oembed.com) object. */
1618
+ oembed?: Oembed$2;
1619
+ /** Origin asset source. */
1620
+ src?: string | null;
1621
+ }
1622
+ interface Oembed$2 {
1623
+ /** The resource type. */
1624
+ type?: string | null;
1625
+ /** The width of the resource specified in the `url` property in pixels. */
1626
+ width?: number | null;
1627
+ /** The height of the resource specified in the `url` property in pixels. */
1628
+ height?: number | null;
1629
+ /** Resource title. */
1630
+ title?: string | null;
1631
+ /** The source URL for the resource. */
1632
+ url?: string | null;
1633
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1634
+ html?: string | null;
1635
+ /** The name of the author or owner of the resource. */
1636
+ authorName?: string | null;
1637
+ /** The URL for the author or owner of the resource. */
1638
+ authorUrl?: string | null;
1639
+ /** The name of the resource provider. */
1640
+ providerName?: string | null;
1641
+ /** The URL for the resource provider. */
1642
+ providerUrl?: string | null;
1643
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1644
+ thumbnailUrl?: string | null;
1645
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1646
+ thumbnailWidth?: string | null;
1647
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1648
+ thumbnailHeight?: string | null;
1649
+ /** The URL for an embedded viedo. */
1650
+ videoUrl?: string | null;
1651
+ /** The oEmbed version number. This value must be `1.0`. */
1652
+ version?: string | null;
1653
+ }
1654
+ interface CollapsibleListData$2 {
1655
+ /** Styling for the collapsible list's container. */
1656
+ containerData?: PluginContainerData$2;
1657
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1658
+ expandOnlyOne?: boolean | null;
1659
+ /** Sets which items are expanded when the page loads. */
1660
+ initialExpandedItems?: InitialExpandedItems$2;
1661
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1662
+ direction?: Direction$2;
1663
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1664
+ isQapageData?: boolean | null;
1665
+ }
1666
+ declare enum InitialExpandedItems$2 {
1667
+ /** First item will be expended initally */
1668
+ FIRST = "FIRST",
1669
+ /** All items will expended initally */
1670
+ ALL = "ALL",
1671
+ /** All items collapsed initally */
1672
+ NONE = "NONE"
1673
+ }
1674
+ declare enum Direction$2 {
1675
+ /** Left-to-right */
1676
+ LTR = "LTR",
1677
+ /** Right-to-left */
1678
+ RTL = "RTL"
1679
+ }
1680
+ interface TableData$2 {
1681
+ /** Styling for the table's container. */
1682
+ containerData?: PluginContainerData$2;
1683
+ /** The table's dimensions. */
1684
+ dimensions?: Dimensions$2;
1685
+ /**
1686
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1687
+ * @deprecated
1688
+ */
1689
+ header?: boolean | null;
1690
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1691
+ rowHeader?: boolean | null;
1692
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1693
+ columnHeader?: boolean | null;
1694
+ }
1695
+ interface Dimensions$2 {
1696
+ /** An array representing relative width of each column in relation to the other columns. */
1697
+ colsWidthRatio?: number[];
1698
+ /** An array representing the height of each row in pixels. */
1699
+ rowsHeight?: number[];
1700
+ /** An array representing the minimum width of each column in pixels. */
1701
+ colsMinWidth?: number[];
1702
+ }
1703
+ interface TableCellData$2 {
1704
+ /** Styling for the cell's background color and text alignment. */
1705
+ cellStyle?: CellStyle$2;
1706
+ /** The cell's border colors. */
1707
+ borderColors?: BorderColors$2;
1708
+ }
1709
+ declare enum VerticalAlignment$2 {
1710
+ /** Top alignment */
1711
+ TOP = "TOP",
1712
+ /** Middle alignment */
1713
+ MIDDLE = "MIDDLE",
1714
+ /** Bottom alignment */
1715
+ BOTTOM = "BOTTOM"
1716
+ }
1717
+ interface CellStyle$2 {
1718
+ /** Vertical alignment for the cell's text. */
1719
+ verticalAlignment?: VerticalAlignment$2;
1720
+ /** Cell background color as a hexadecimal value. */
1721
+ backgroundColor?: string | null;
1722
+ }
1723
+ interface BorderColors$2 {
1724
+ /** Left border color as a hexadecimal value. */
1725
+ left?: string | null;
1726
+ /** Right border color as a hexadecimal value. */
1727
+ right?: string | null;
1728
+ /** Top border color as a hexadecimal value. */
1729
+ top?: string | null;
1730
+ /** Bottom border color as a hexadecimal value. */
1731
+ bottom?: string | null;
1732
+ }
1733
+ /**
1734
+ * `NullValue` is a singleton enumeration to represent the null value for the
1735
+ * `Value` type union.
1736
+ *
1737
+ * The JSON representation for `NullValue` is JSON `null`.
1738
+ */
1739
+ declare enum NullValue$2 {
1740
+ /** Null value. */
1741
+ NULL_VALUE = "NULL_VALUE"
1742
+ }
1743
+ /**
1744
+ * `ListValue` is a wrapper around a repeated field of values.
1745
+ *
1746
+ * The JSON representation for `ListValue` is JSON array.
1747
+ */
1748
+ interface ListValue$2 {
1749
+ /** Repeated field of dynamically typed values. */
1750
+ values?: any[];
1751
+ }
1752
+ interface AudioData$2 {
1753
+ /** Styling for the audio node's container. */
1754
+ containerData?: PluginContainerData$2;
1755
+ /** Audio file details. */
1756
+ audio?: Media$2;
1757
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1758
+ disableDownload?: boolean | null;
1759
+ /** Cover image. */
1760
+ coverImage?: Media$2;
1761
+ /** Track name. */
1762
+ name?: string | null;
1763
+ /** Author name. */
1764
+ authorName?: string | null;
1765
+ /** An HTML version of the audio node. */
1766
+ html?: string | null;
1767
+ }
1768
+ interface OrderedListData$2 {
1769
+ /** Indentation level from 0-4. */
1770
+ indentation?: number;
1771
+ /** Offset level from 0-4. */
1772
+ offset?: number | null;
1773
+ }
1774
+ interface BulletedListData$2 {
1775
+ /** Indentation level from 0-4. */
1776
+ indentation?: number;
1777
+ /** Offset level from 0-4. */
1778
+ offset?: number | null;
1779
+ }
1780
+ interface BlockquoteData$2 {
1781
+ /** Indentation level from 1-4. */
1782
+ indentation?: number;
1783
+ }
1784
+ interface Metadata$2 {
1785
+ /** Schema version. */
1786
+ version?: number;
1787
+ /**
1788
+ * When the object was created.
1789
+ * @readonly
1790
+ * @deprecated
1791
+ */
1792
+ createdTimestamp?: Date;
1793
+ /**
1794
+ * When the object was most recently updated.
1795
+ * @deprecated
1796
+ */
1797
+ updatedTimestamp?: Date;
1798
+ /** Object ID. */
1799
+ _id?: string | null;
1800
+ }
1801
+ interface DocumentStyle$2 {
1802
+ /** Styling for H1 nodes. */
1803
+ headerOne?: TextNodeStyle$2;
1804
+ /** Styling for H2 nodes. */
1805
+ headerTwo?: TextNodeStyle$2;
1806
+ /** Styling for H3 nodes. */
1807
+ headerThree?: TextNodeStyle$2;
1808
+ /** Styling for H4 nodes. */
1809
+ headerFour?: TextNodeStyle$2;
1810
+ /** Styling for H5 nodes. */
1811
+ headerFive?: TextNodeStyle$2;
1812
+ /** Styling for H6 nodes. */
1813
+ headerSix?: TextNodeStyle$2;
1814
+ /** Styling for paragraph nodes. */
1815
+ paragraph?: TextNodeStyle$2;
1816
+ /** Styling for block quote nodes. */
1817
+ blockquote?: TextNodeStyle$2;
1818
+ /** Styling for code block nodes. */
1819
+ codeBlock?: TextNodeStyle$2;
1820
+ }
1821
+ interface TextNodeStyle$2 {
1822
+ /** The decorations to apply to the node. */
1823
+ decorations?: Decoration$2[];
1824
+ /** Padding and background color for the node. */
1825
+ nodeStyle?: NodeStyle$2;
1826
+ /** Line height for text in the node. */
1827
+ lineHeight?: string | null;
1828
+ }
1829
+ interface VideoResolution$1 {
1830
+ /** Video URL. */
1831
+ url?: string;
1832
+ /** Video height. */
1833
+ height?: number;
1834
+ /** Video width. */
1835
+ width?: number;
1836
+ /** Video format for example, mp4, hls. */
1837
+ format?: string;
1838
+ }
1839
+ interface ExtendedFields {
1840
+ /**
1841
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1842
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1843
+ *
1844
+ * You can only access fields for which you have the appropriate permissions.
1845
+ *
1846
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1847
+ */
1848
+ namespaces?: Record<string, Record<string, any>>;
1849
+ }
1850
+ interface GetPublishedContentRequest {
1851
+ /** The ID of the published content */
1852
+ contentId?: string;
1853
+ }
1854
+ interface GetPublishedContentResponse {
1855
+ /** The published content */
1856
+ publishedContent?: PublishedContent;
1857
+ }
1858
+ interface QueryPublishedContentRequest {
1859
+ /** The query to filter the published content */
1860
+ query: CursorQuery$2;
1861
+ }
1862
+ interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
1863
+ /**
1864
+ * Cursor paging options.
1865
+ *
1866
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1867
+ */
1868
+ cursorPaging?: CursorPaging$2;
1869
+ /**
1870
+ * Filter object.
1871
+ *
1872
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1873
+ */
1874
+ filter?: Record<string, any> | null;
1875
+ /**
1876
+ * Sort object.
1877
+ *
1878
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1879
+ */
1880
+ sort?: Sorting$2[];
1881
+ }
1882
+ /** @oneof */
1883
+ interface CursorQueryPagingMethodOneOf$2 {
1884
+ /**
1885
+ * Cursor paging options.
1886
+ *
1887
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1888
+ */
1889
+ cursorPaging?: CursorPaging$2;
1890
+ }
1891
+ interface Sorting$2 {
1892
+ /** Name of the field to sort by. */
1893
+ fieldName?: string;
1894
+ /** Sort order. */
1895
+ order?: SortOrder$2;
1896
+ }
1897
+ declare enum SortOrder$2 {
1898
+ ASC = "ASC",
1899
+ DESC = "DESC"
1900
+ }
1901
+ interface CursorPaging$2 {
1902
+ /** Maximum number of items to return in the results. */
1903
+ limit?: number | null;
1904
+ /**
1905
+ * Pointer to the next or previous page in the list of results.
1906
+ *
1907
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1908
+ * Not relevant for the first request.
1909
+ */
1910
+ cursor?: string | null;
1911
+ }
1912
+ interface QueryPublishedContentResponse {
1913
+ /** The published content */
1914
+ publishedContent?: PublishedContent[];
1915
+ /** Paging information */
1916
+ pagingMetadata?: CursorPagingMetadata$2;
1917
+ }
1918
+ interface CursorPagingMetadata$2 {
1919
+ /** Number of items returned in current page. */
1920
+ count?: number | null;
1921
+ /** Cursor strings that point to the next page, previous page, or both. */
1922
+ cursors?: Cursors$2;
1923
+ /**
1924
+ * Whether there are more pages to retrieve following the current page.
1925
+ *
1926
+ * + `true`: Another page of results can be retrieved.
1927
+ * + `false`: This is the last page.
1928
+ */
1929
+ hasNext?: boolean | null;
1930
+ }
1931
+ interface Cursors$2 {
1932
+ /** Cursor string pointing to the next page in the list of results. */
1933
+ next?: string | null;
1934
+ /** Cursor pointing to the previous page in the list of results. */
1935
+ prev?: string | null;
1936
+ }
1937
+ interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
1938
+ createdEvent?: EntityCreatedEvent$2;
1939
+ updatedEvent?: EntityUpdatedEvent$2;
1940
+ deletedEvent?: EntityDeletedEvent$2;
1941
+ actionEvent?: ActionEvent$2;
1942
+ /**
1943
+ * Unique event ID.
1944
+ * Allows clients to ignore duplicate webhooks.
1945
+ */
1946
+ _id?: string;
1947
+ /**
1948
+ * Assumes actions are also always typed to an entity_type
1949
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1950
+ */
1951
+ entityFqdn?: string;
1952
+ /**
1953
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1954
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1955
+ * Example: created/updated/deleted/started/completed/email_opened
1956
+ */
1957
+ slug?: string;
1958
+ /** ID of the entity associated with the event. */
1959
+ entityId?: string;
1960
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1961
+ eventTime?: Date;
1962
+ /**
1963
+ * Whether the event was triggered as a result of a privacy regulation application
1964
+ * (for example, GDPR).
1965
+ */
1966
+ triggeredByAnonymizeRequest?: boolean | null;
1967
+ /** If present, indicates the action that triggered the event. */
1968
+ originatedFrom?: string | null;
1969
+ /**
1970
+ * A sequence number defining the order of updates to the underlying entity.
1971
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1972
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1973
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1974
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1975
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1976
+ */
1977
+ entityEventSequence?: string | null;
1978
+ }
1979
+ /** @oneof */
1980
+ interface DomainEventBodyOneOf$2 {
1981
+ createdEvent?: EntityCreatedEvent$2;
1982
+ updatedEvent?: EntityUpdatedEvent$2;
1983
+ deletedEvent?: EntityDeletedEvent$2;
1984
+ actionEvent?: ActionEvent$2;
1985
+ }
1986
+ interface EntityCreatedEvent$2 {
1987
+ entity?: string;
1988
+ }
1989
+ interface RestoreInfo$2 {
1990
+ deletedDate?: Date;
1991
+ }
1992
+ interface EntityUpdatedEvent$2 {
1993
+ /**
1994
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1995
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1996
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1997
+ */
1998
+ currentEntity?: string;
1999
+ }
2000
+ interface EntityDeletedEvent$2 {
2001
+ /** Entity that was deleted */
2002
+ deletedEntity?: string | null;
2003
+ }
2004
+ interface ActionEvent$2 {
2005
+ body?: string;
323
2006
  }
324
2007
  interface MessageEnvelope$2 {
325
2008
  /** App instance ID. */
@@ -361,159 +2044,358 @@ declare enum WebhookIdentityType$2 {
361
2044
  WIX_USER = "WIX_USER",
362
2045
  APP = "APP"
363
2046
  }
364
- interface HtmlNewRevisionSavedMessage {
365
- /** HTML Site ID */
366
- siteId?: string;
367
- /** Newly saved revision */
368
- revision?: string;
369
- /** Restored from revision */
370
- restoredFrom?: string | null;
371
- /** Optional meta site id */
372
- metaSiteId?: string | null;
373
- /** Date that this version was updated (same as created) */
374
- updateDate?: string;
375
- /** determine whether this site uses responsive editor */
376
- isResponsive?: boolean;
377
- /** optional branch id if revision saved on branch */
378
- branchId?: string | null;
379
- /** determine if the new revision is a result of override save */
380
- overrideSave?: boolean;
381
- /** Optional last transaction id */
382
- lastTransactionId?: string | null;
383
- /** optional branch id if revision restored from branch */
384
- restoredFromBranchId?: string | null;
385
- /** information of revision prior to save revision operation */
386
- lastRevisionInfo?: RevisionInfo;
387
- /** new revision pages */
388
- pages?: Page[];
389
- /** the pages that were changed from the last save. Operations such as clone and restore will return an empty response at the moment. */
390
- changedPages?: ChangedPages;
391
- /** id of the main page of the site */
392
- mainPageId?: string;
2047
+ interface SchemaKeyNonNullableFields$1 {
2048
+ appId: string;
2049
+ entityType: string;
2050
+ scope: SchemaScope$1;
393
2051
  }
394
- interface RevisionInfo {
395
- /** revision number */
396
- revision?: string;
397
- /** last_transaction_id of revision */
398
- lastTransactionId?: string | null;
2052
+ interface PluginContainerDataWidthNonNullableFields$1 {
2053
+ size: WidthType$2;
399
2054
  }
400
- interface Page {
401
- /** Page's Id */
402
- _id?: string;
2055
+ interface PluginContainerDataNonNullableFields$1 {
2056
+ width?: PluginContainerDataWidthNonNullableFields$1;
2057
+ alignment: PluginContainerDataAlignment$2;
403
2058
  }
404
- interface ChangedPages {
405
- /** list of updated_pages */
406
- updatedPages?: Page[];
407
- /** list of deleted_pages */
408
- deletedPages?: Page[];
2059
+ interface LinkNonNullableFields$1 {
2060
+ url: string;
2061
+ anchor: string;
2062
+ target: Target$2;
409
2063
  }
410
- interface SyncEditorDataRequest {
411
- /** an optional filter for syncing the content */
412
- syncFilter?: SyncFilter;
2064
+ interface ButtonDataNonNullableFields$1 {
2065
+ containerData?: PluginContainerDataNonNullableFields$1;
2066
+ type: Type$2;
2067
+ link?: LinkNonNullableFields$1;
413
2068
  }
414
- interface SyncFilter {
415
- /** content IETF BCP 47 language tag */
416
- languageTag?: string;
2069
+ interface TextStyleNonNullableFields$1 {
2070
+ textAlignment: TextAlignment$2;
417
2071
  }
418
- interface SyncEditorDataResponse {
2072
+ interface CodeBlockDataNonNullableFields$1 {
2073
+ textStyle?: TextStyleNonNullableFields$1;
419
2074
  }
420
- interface PublishSiteTranslationsRequest {
421
- /** A language to publish it's language */
422
- language?: string;
2075
+ interface DividerDataNonNullableFields$1 {
2076
+ containerData?: PluginContainerDataNonNullableFields$1;
2077
+ lineStyle: LineStyle$2;
2078
+ width: Width$2;
2079
+ alignment: Alignment$2;
423
2080
  }
424
- interface PublishSiteTranslationsResponse {
2081
+ interface PDFSettingsNonNullableFields$1 {
2082
+ viewMode: ViewMode$2;
425
2083
  }
426
- interface V1CreateOrUpdateMapperRequest {
427
- /** A mapper to create or update if already exist */
428
- mapper?: Mapper;
2084
+ interface FileDataNonNullableFields$1 {
2085
+ containerData?: PluginContainerDataNonNullableFields$1;
2086
+ pdfSettings?: PDFSettingsNonNullableFields$1;
429
2087
  }
430
- interface V1CreateOrUpdateMapperResponse {
2088
+ interface ImageNonNullableFields$1 {
2089
+ link?: LinkNonNullableFields$1;
431
2090
  }
432
- interface GetMapperRequest {
433
- /** The mapper type requested */
434
- entityType?: string;
2091
+ interface ItemNonNullableFields$1 {
2092
+ image?: ImageNonNullableFields$1;
435
2093
  }
436
- interface GetMapperResponse {
437
- /** The mapper with the entity type requested */
438
- mapper?: Mapper;
2094
+ interface LayoutNonNullableFields$1 {
2095
+ type: LayoutType$2;
2096
+ orientation: Orientation$2;
439
2097
  }
440
- interface DeleteMapperRequest {
441
- /** The entity type to delete from the service */
442
- entityType?: string;
2098
+ interface ItemStyleNonNullableFields$1 {
2099
+ crop: Crop$2;
443
2100
  }
444
- interface DeleteMapperResponse {
2101
+ interface ThumbnailsNonNullableFields$1 {
2102
+ placement: ThumbnailsAlignment$2;
445
2103
  }
446
- interface ListMappersRequest {
2104
+ interface GalleryOptionsNonNullableFields$1 {
2105
+ layout?: LayoutNonNullableFields$1;
2106
+ item?: ItemStyleNonNullableFields$1;
2107
+ thumbnails?: ThumbnailsNonNullableFields$1;
447
2108
  }
448
- interface ListMappersResponse {
449
- /** all mappers known to editor adapter */
450
- mappers?: Mapper[];
2109
+ interface GalleryDataNonNullableFields$1 {
2110
+ containerData?: PluginContainerDataNonNullableFields$1;
2111
+ items: ItemNonNullableFields$1[];
2112
+ options?: GalleryOptionsNonNullableFields$1;
451
2113
  }
452
- interface StressDMRequest {
453
- /** the meta site id to stress */
454
- metaSiteId?: string;
2114
+ interface GIFDataNonNullableFields$1 {
2115
+ containerData?: PluginContainerDataNonNullableFields$1;
2116
+ height: number;
2117
+ width: number;
455
2118
  }
456
- interface StressDMResponse {
2119
+ interface HeadingDataNonNullableFields$1 {
2120
+ level: number;
2121
+ textStyle?: TextStyleNonNullableFields$1;
457
2122
  }
458
- interface SyncEditorDataOptions {
459
- /** an optional filter for syncing the content */
460
- syncFilter?: SyncFilter;
2123
+ interface HTMLDataNonNullableFields$1 {
2124
+ url: string;
2125
+ html: string;
2126
+ containerData?: PluginContainerDataNonNullableFields$1;
2127
+ source: Source$2;
2128
+ }
2129
+ interface ImageDataNonNullableFields$1 {
2130
+ containerData?: PluginContainerDataNonNullableFields$1;
2131
+ link?: LinkNonNullableFields$1;
2132
+ }
2133
+ interface LinkPreviewDataNonNullableFields$1 {
2134
+ containerData?: PluginContainerDataNonNullableFields$1;
2135
+ link?: LinkNonNullableFields$1;
2136
+ }
2137
+ interface MapSettingsNonNullableFields$1 {
2138
+ mapType: MapType$2;
2139
+ }
2140
+ interface MapDataNonNullableFields$1 {
2141
+ containerData?: PluginContainerDataNonNullableFields$1;
2142
+ mapSettings?: MapSettingsNonNullableFields$1;
2143
+ }
2144
+ interface ParagraphDataNonNullableFields$1 {
2145
+ textStyle?: TextStyleNonNullableFields$1;
2146
+ }
2147
+ interface PermissionsNonNullableFields$1 {
2148
+ view: ViewRole$2;
2149
+ vote: VoteRole$2;
2150
+ }
2151
+ interface SettingsNonNullableFields$1 {
2152
+ permissions?: PermissionsNonNullableFields$1;
2153
+ }
2154
+ interface PollNonNullableFields$1 {
2155
+ settings?: SettingsNonNullableFields$1;
2156
+ }
2157
+ interface PollLayoutNonNullableFields$1 {
2158
+ type: PollLayoutType$2;
2159
+ direction: PollLayoutDirection$2;
2160
+ }
2161
+ interface PollDataLayoutNonNullableFields$1 {
2162
+ poll?: PollLayoutNonNullableFields$1;
2163
+ }
2164
+ interface BackgroundNonNullableFields$1 {
2165
+ type: BackgroundType$2;
2166
+ }
2167
+ interface PollDesignNonNullableFields$1 {
2168
+ background?: BackgroundNonNullableFields$1;
2169
+ }
2170
+ interface DesignNonNullableFields$1 {
2171
+ poll?: PollDesignNonNullableFields$1;
2172
+ }
2173
+ interface PollDataNonNullableFields$1 {
2174
+ containerData?: PluginContainerDataNonNullableFields$1;
2175
+ poll?: PollNonNullableFields$1;
2176
+ layout?: PollDataLayoutNonNullableFields$1;
2177
+ design?: DesignNonNullableFields$1;
2178
+ }
2179
+ interface AnchorDataNonNullableFields$1 {
2180
+ anchor: string;
2181
+ }
2182
+ interface LinkDataNonNullableFields$1 {
2183
+ link?: LinkNonNullableFields$1;
2184
+ }
2185
+ interface MentionDataNonNullableFields$1 {
2186
+ name: string;
2187
+ slug: string;
2188
+ }
2189
+ interface FontSizeDataNonNullableFields$1 {
2190
+ unit: FontType$2;
2191
+ }
2192
+ interface DecorationNonNullableFields$1 {
2193
+ anchorData?: AnchorDataNonNullableFields$1;
2194
+ linkData?: LinkDataNonNullableFields$1;
2195
+ mentionData?: MentionDataNonNullableFields$1;
2196
+ fontSizeData?: FontSizeDataNonNullableFields$1;
2197
+ type: DecorationType$2;
2198
+ }
2199
+ interface TextDataNonNullableFields$1 {
2200
+ text: string;
2201
+ decorations: DecorationNonNullableFields$1[];
2202
+ }
2203
+ interface AppEmbedDataNonNullableFields$1 {
2204
+ type: AppType$2;
2205
+ }
2206
+ interface VideoDataNonNullableFields$1 {
2207
+ containerData?: PluginContainerDataNonNullableFields$1;
2208
+ }
2209
+ interface EmbedDataNonNullableFields$1 {
2210
+ containerData?: PluginContainerDataNonNullableFields$1;
2211
+ }
2212
+ interface CollapsibleListDataNonNullableFields$1 {
2213
+ containerData?: PluginContainerDataNonNullableFields$1;
2214
+ initialExpandedItems: InitialExpandedItems$2;
2215
+ direction: Direction$2;
2216
+ }
2217
+ interface DimensionsNonNullableFields$1 {
2218
+ colsWidthRatio: number[];
2219
+ rowsHeight: number[];
2220
+ colsMinWidth: number[];
2221
+ }
2222
+ interface TableDataNonNullableFields$1 {
2223
+ containerData?: PluginContainerDataNonNullableFields$1;
2224
+ dimensions?: DimensionsNonNullableFields$1;
2225
+ }
2226
+ interface CellStyleNonNullableFields$1 {
2227
+ verticalAlignment: VerticalAlignment$2;
2228
+ }
2229
+ interface TableCellDataNonNullableFields$1 {
2230
+ cellStyle?: CellStyleNonNullableFields$1;
2231
+ }
2232
+ interface AudioDataNonNullableFields$1 {
2233
+ containerData?: PluginContainerDataNonNullableFields$1;
2234
+ }
2235
+ interface OrderedListDataNonNullableFields$1 {
2236
+ indentation: number;
2237
+ }
2238
+ interface BulletedListDataNonNullableFields$1 {
2239
+ indentation: number;
2240
+ }
2241
+ interface BlockquoteDataNonNullableFields$1 {
2242
+ indentation: number;
2243
+ }
2244
+ interface NodeNonNullableFields$1 {
2245
+ buttonData?: ButtonDataNonNullableFields$1;
2246
+ codeBlockData?: CodeBlockDataNonNullableFields$1;
2247
+ dividerData?: DividerDataNonNullableFields$1;
2248
+ fileData?: FileDataNonNullableFields$1;
2249
+ galleryData?: GalleryDataNonNullableFields$1;
2250
+ gifData?: GIFDataNonNullableFields$1;
2251
+ headingData?: HeadingDataNonNullableFields$1;
2252
+ htmlData?: HTMLDataNonNullableFields$1;
2253
+ imageData?: ImageDataNonNullableFields$1;
2254
+ linkPreviewData?: LinkPreviewDataNonNullableFields$1;
2255
+ mapData?: MapDataNonNullableFields$1;
2256
+ paragraphData?: ParagraphDataNonNullableFields$1;
2257
+ pollData?: PollDataNonNullableFields$1;
2258
+ textData?: TextDataNonNullableFields$1;
2259
+ appEmbedData?: AppEmbedDataNonNullableFields$1;
2260
+ videoData?: VideoDataNonNullableFields$1;
2261
+ embedData?: EmbedDataNonNullableFields$1;
2262
+ collapsibleListData?: CollapsibleListDataNonNullableFields$1;
2263
+ tableData?: TableDataNonNullableFields$1;
2264
+ tableCellData?: TableCellDataNonNullableFields$1;
2265
+ audioData?: AudioDataNonNullableFields$1;
2266
+ orderedListData?: OrderedListDataNonNullableFields$1;
2267
+ bulletedListData?: BulletedListDataNonNullableFields$1;
2268
+ blockquoteData?: BlockquoteDataNonNullableFields$1;
2269
+ type: NodeType$2;
2270
+ _id: string;
2271
+ nodes: NodeNonNullableFields$1[];
2272
+ }
2273
+ interface MetadataNonNullableFields$1 {
2274
+ version: number;
2275
+ }
2276
+ interface TextNodeStyleNonNullableFields$1 {
2277
+ decorations: DecorationNonNullableFields$1[];
2278
+ }
2279
+ interface DocumentStyleNonNullableFields$1 {
2280
+ headerOne?: TextNodeStyleNonNullableFields$1;
2281
+ headerTwo?: TextNodeStyleNonNullableFields$1;
2282
+ headerThree?: TextNodeStyleNonNullableFields$1;
2283
+ headerFour?: TextNodeStyleNonNullableFields$1;
2284
+ headerFive?: TextNodeStyleNonNullableFields$1;
2285
+ headerSix?: TextNodeStyleNonNullableFields$1;
2286
+ paragraph?: TextNodeStyleNonNullableFields$1;
2287
+ blockquote?: TextNodeStyleNonNullableFields$1;
2288
+ codeBlock?: TextNodeStyleNonNullableFields$1;
2289
+ }
2290
+ interface RichContentNonNullableFields$1 {
2291
+ nodes: NodeNonNullableFields$1[];
2292
+ metadata?: MetadataNonNullableFields$1;
2293
+ documentStyle?: DocumentStyleNonNullableFields$1;
2294
+ }
2295
+ interface PublishedContentFieldNonNullableFields {
2296
+ textValue: string;
2297
+ richContent?: RichContentNonNullableFields$1;
2298
+ image: string;
2299
+ video: string;
2300
+ document: string;
2301
+ schemaFieldKey: string;
2302
+ sequenceIds: string[];
2303
+ }
2304
+ interface PublishedContentNonNullableFields {
2305
+ schemaKey?: SchemaKeyNonNullableFields$1;
2306
+ entityId: string;
2307
+ locale: string;
2308
+ fields: PublishedContentFieldNonNullableFields[];
2309
+ }
2310
+ interface QueryPublishedContentResponseNonNullableFields {
2311
+ publishedContent: PublishedContentNonNullableFields[];
2312
+ }
2313
+ interface QueryCursorResult$2 {
2314
+ cursors: Cursors$2;
2315
+ hasNext: () => boolean;
2316
+ hasPrev: () => boolean;
2317
+ length: number;
2318
+ pageSize: number;
2319
+ }
2320
+ interface PublishedContentQueryResult extends QueryCursorResult$2 {
2321
+ items: PublishedContent[];
2322
+ query: PublishedContentQueryBuilder;
2323
+ next: () => Promise<PublishedContentQueryResult>;
2324
+ prev: () => Promise<PublishedContentQueryResult>;
2325
+ }
2326
+ interface PublishedContentQueryBuilder {
2327
+ /** @param propertyName - Property whose value is compared with `value`.
2328
+ * @param value - Value to compare against.
2329
+ * @documentationMaturity preview
2330
+ */
2331
+ eq: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
2332
+ /** @param propertyName - Property whose value is compared with `value`.
2333
+ * @param value - Value to compare against.
2334
+ * @documentationMaturity preview
2335
+ */
2336
+ ne: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
2337
+ /** @param propertyName - Property whose value is compared with `string`.
2338
+ * @param string - String to compare against. Case-insensitive.
2339
+ * @documentationMaturity preview
2340
+ */
2341
+ startsWith: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'entityId' | 'locale' | 'parentEntityId', value: string) => PublishedContentQueryBuilder;
2342
+ /** @param propertyName - Property whose value is compared with `values`.
2343
+ * @param values - List of values to compare against.
2344
+ * @documentationMaturity preview
2345
+ */
2346
+ hasSome: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: any[]) => PublishedContentQueryBuilder;
2347
+ /** @documentationMaturity preview */
2348
+ in: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
2349
+ /** @documentationMaturity preview */
2350
+ exists: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: boolean) => PublishedContentQueryBuilder;
2351
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2352
+ * @documentationMaturity preview
2353
+ */
2354
+ ascending: (...propertyNames: Array<'_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId'>) => PublishedContentQueryBuilder;
2355
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2356
+ * @documentationMaturity preview
2357
+ */
2358
+ descending: (...propertyNames: Array<'_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId'>) => PublishedContentQueryBuilder;
2359
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2360
+ * @documentationMaturity preview
2361
+ */
2362
+ limit: (limit: number) => PublishedContentQueryBuilder;
2363
+ /** @param cursor - A pointer to specific record
2364
+ * @documentationMaturity preview
2365
+ */
2366
+ skipTo: (cursor: string) => PublishedContentQueryBuilder;
2367
+ /** @documentationMaturity preview */
2368
+ find: () => Promise<PublishedContentQueryResult>;
461
2369
  }
462
2370
 
463
- declare function syncEditorData$1(httpClient: HttpClient): (options?: SyncEditorDataOptions) => Promise<void>;
2371
+ declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
2372
+ interface QueryPublishedContentSignature {
2373
+ /**
2374
+ * Query the published content of multiple entities using the schema key and optionally other criteria
2375
+ */
2376
+ (): PublishedContentQueryBuilder;
2377
+ }
464
2378
 
465
2379
  declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
466
2380
 
467
- type _publicSyncEditorDataType = typeof syncEditorData$1;
468
- declare const syncEditorData: ReturnType<typeof createRESTModule$4<_publicSyncEditorDataType>>;
2381
+ type _publicQueryPublishedContentType = typeof queryPublishedContent$1;
2382
+ declare const queryPublishedContent: ReturnType<typeof createRESTModule$4<_publicQueryPublishedContentType>>;
469
2383
 
470
- type context$4_ChangedPages = ChangedPages;
471
- type context$4_CreateOrUpdateAction = CreateOrUpdateAction;
472
- type context$4_CreateOrUpdateMapperRequest = CreateOrUpdateMapperRequest;
473
- type context$4_CreateOrUpdateMapperResponse = CreateOrUpdateMapperResponse;
474
- type context$4_DeleteAction = DeleteAction;
475
- type context$4_DeleteEntityMapperRequest = DeleteEntityMapperRequest;
476
- type context$4_DeleteEntityMapperResponse = DeleteEntityMapperResponse;
477
- type context$4_DeleteMapperRequest = DeleteMapperRequest;
478
- type context$4_DeleteMapperResponse = DeleteMapperResponse;
479
- type context$4_FieldSequence = FieldSequence;
480
- type context$4_GetEntityMapperRequest = GetEntityMapperRequest;
481
- type context$4_GetEntityMapperResponse = GetEntityMapperResponse;
482
- type context$4_GetMapperRequest = GetMapperRequest;
483
- type context$4_GetMapperResponse = GetMapperResponse;
484
- type context$4_GetSubscribedTopicsRequest = GetSubscribedTopicsRequest;
485
- type context$4_GetSubscribedTopicsResponse = GetSubscribedTopicsResponse;
486
- type context$4_HtmlNewRevisionSavedMessage = HtmlNewRevisionSavedMessage;
487
- type context$4_ListMappersRequest = ListMappersRequest;
488
- type context$4_ListMappersResponse = ListMappersResponse;
489
- type context$4_LocalizationPublicAction = LocalizationPublicAction;
490
- type context$4_LocalizationPublicActionActionOneOf = LocalizationPublicActionActionOneOf;
491
- type context$4_LocalizedContentKey = LocalizedContentKey;
492
- type context$4_LocalizedPublishedContent = LocalizedPublishedContent;
493
- type context$4_LocalizedPublishedContentField = LocalizedPublishedContentField;
494
- type context$4_LocalizedPublishedContentFieldValueOneOf = LocalizedPublishedContentFieldValueOneOf;
495
- type context$4_LocalizedPublishedLanguageContentChanged = LocalizedPublishedLanguageContentChanged;
496
- type context$4_Mapper = Mapper;
497
- type context$4_MapperField = MapperField;
498
- type context$4_MediaItem = MediaItem;
499
- type context$4_MediaItemMediaOneOf = MediaItemMediaOneOf;
500
- type context$4_Page = Page;
501
- type context$4_PublishSiteTranslationsRequest = PublishSiteTranslationsRequest;
502
- type context$4_PublishSiteTranslationsResponse = PublishSiteTranslationsResponse;
503
- type context$4_RevisionInfo = RevisionInfo;
504
- type context$4_SequencePath = SequencePath;
505
- type context$4_StressDMRequest = StressDMRequest;
506
- type context$4_StressDMResponse = StressDMResponse;
507
- type context$4_SyncEditorDataOptions = SyncEditorDataOptions;
508
- type context$4_SyncEditorDataRequest = SyncEditorDataRequest;
509
- type context$4_SyncEditorDataResponse = SyncEditorDataResponse;
510
- type context$4_SyncFilter = SyncFilter;
511
- type context$4_V1CreateOrUpdateMapperRequest = V1CreateOrUpdateMapperRequest;
512
- type context$4_V1CreateOrUpdateMapperResponse = V1CreateOrUpdateMapperResponse;
513
- type context$4__publicSyncEditorDataType = _publicSyncEditorDataType;
514
- declare const context$4_syncEditorData: typeof syncEditorData;
2384
+ type context$4_ExtendedFields = ExtendedFields;
2385
+ type context$4_GetPublishedContentRequest = GetPublishedContentRequest;
2386
+ type context$4_GetPublishedContentResponse = GetPublishedContentResponse;
2387
+ type context$4_PublishedContent = PublishedContent;
2388
+ type context$4_PublishedContentField = PublishedContentField;
2389
+ type context$4_PublishedContentFieldValueOneOf = PublishedContentFieldValueOneOf;
2390
+ type context$4_PublishedContentQueryBuilder = PublishedContentQueryBuilder;
2391
+ type context$4_PublishedContentQueryResult = PublishedContentQueryResult;
2392
+ type context$4_QueryPublishedContentRequest = QueryPublishedContentRequest;
2393
+ type context$4_QueryPublishedContentResponse = QueryPublishedContentResponse;
2394
+ type context$4_QueryPublishedContentResponseNonNullableFields = QueryPublishedContentResponseNonNullableFields;
2395
+ type context$4__publicQueryPublishedContentType = _publicQueryPublishedContentType;
2396
+ declare const context$4_queryPublishedContent: typeof queryPublishedContent;
515
2397
  declare namespace context$4 {
516
- export { type ActionEvent$2 as ActionEvent, type context$4_ChangedPages as ChangedPages, type context$4_CreateOrUpdateAction as CreateOrUpdateAction, type context$4_CreateOrUpdateMapperRequest as CreateOrUpdateMapperRequest, type context$4_CreateOrUpdateMapperResponse as CreateOrUpdateMapperResponse, type context$4_DeleteAction as DeleteAction, type context$4_DeleteEntityMapperRequest as DeleteEntityMapperRequest, type context$4_DeleteEntityMapperResponse as DeleteEntityMapperResponse, type context$4_DeleteMapperRequest as DeleteMapperRequest, type context$4_DeleteMapperResponse as DeleteMapperResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type context$4_FieldSequence as FieldSequence, FieldType$1 as FieldType, type context$4_GetEntityMapperRequest as GetEntityMapperRequest, type context$4_GetEntityMapperResponse as GetEntityMapperResponse, type context$4_GetMapperRequest as GetMapperRequest, type context$4_GetMapperResponse as GetMapperResponse, type context$4_GetSubscribedTopicsRequest as GetSubscribedTopicsRequest, type context$4_GetSubscribedTopicsResponse as GetSubscribedTopicsResponse, type context$4_HtmlNewRevisionSavedMessage as HtmlNewRevisionSavedMessage, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$4_ListMappersRequest as ListMappersRequest, type context$4_ListMappersResponse as ListMappersResponse, type context$4_LocalizationPublicAction as LocalizationPublicAction, type context$4_LocalizationPublicActionActionOneOf as LocalizationPublicActionActionOneOf, type context$4_LocalizedContentKey as LocalizedContentKey, type context$4_LocalizedPublishedContent as LocalizedPublishedContent, type context$4_LocalizedPublishedContentField as LocalizedPublishedContentField, type context$4_LocalizedPublishedContentFieldValueOneOf as LocalizedPublishedContentFieldValueOneOf, type context$4_LocalizedPublishedLanguageContentChanged as LocalizedPublishedLanguageContentChanged, type context$4_Mapper as Mapper, type context$4_MapperField as MapperField, type context$4_MediaItem as MediaItem, type context$4_MediaItemMediaOneOf as MediaItemMediaOneOf, type MessageEnvelope$2 as MessageEnvelope, type context$4_Page as Page, type context$4_PublishSiteTranslationsRequest as PublishSiteTranslationsRequest, type context$4_PublishSiteTranslationsResponse as PublishSiteTranslationsResponse, type RestoreInfo$2 as RestoreInfo, type context$4_RevisionInfo as RevisionInfo, type SchemaKey$1 as SchemaKey, SchemaScope$1 as SchemaScope, type context$4_SequencePath as SequencePath, type context$4_StressDMRequest as StressDMRequest, type context$4_StressDMResponse as StressDMResponse, type context$4_SyncEditorDataOptions as SyncEditorDataOptions, type context$4_SyncEditorDataRequest as SyncEditorDataRequest, type context$4_SyncEditorDataResponse as SyncEditorDataResponse, type context$4_SyncFilter as SyncFilter, type context$4_V1CreateOrUpdateMapperRequest as V1CreateOrUpdateMapperRequest, type context$4_V1CreateOrUpdateMapperResponse as V1CreateOrUpdateMapperResponse, type VideoResolution$1 as VideoResolution, WebhookIdentityType$2 as WebhookIdentityType, type context$4__publicSyncEditorDataType as _publicSyncEditorDataType, context$4_syncEditorData as syncEditorData };
2398
+ export { type ActionEvent$2 as ActionEvent, Alignment$2 as Alignment, type AnchorData$2 as AnchorData, type AppEmbedData$2 as AppEmbedData, type AppEmbedDataAppDataOneOf$2 as AppEmbedDataAppDataOneOf, AppType$2 as AppType, type AudioData$2 as AudioData, type Background$2 as Background, type BackgroundBackgroundOneOf$2 as BackgroundBackgroundOneOf, BackgroundType$2 as BackgroundType, type BlockquoteData$2 as BlockquoteData, type BookingData$2 as BookingData, type Border$2 as Border, type BorderColors$2 as BorderColors, type BulletedListData$2 as BulletedListData, type ButtonData$2 as ButtonData, type CellStyle$2 as CellStyle, type CodeBlockData$2 as CodeBlockData, type CollapsibleListData$2 as CollapsibleListData, type ColorData$2 as ColorData, type Colors$2 as Colors, Crop$2 as Crop, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, type Decoration$2 as Decoration, type DecorationDataOneOf$2 as DecorationDataOneOf, DecorationType$2 as DecorationType, type Design$2 as Design, type Dimensions$2 as Dimensions, Direction$2 as Direction, type DividerData$2 as DividerData, type DocumentStyle$2 as DocumentStyle, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EmbedData$2 as EmbedData, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventData$2 as EventData, type context$4_ExtendedFields as ExtendedFields, type FileData$2 as FileData, type FileSource$2 as FileSource, type FileSourceDataOneOf$2 as FileSourceDataOneOf, type FontSizeData$2 as FontSizeData, FontType$2 as FontType, type GIF$2 as GIF, type GIFData$2 as GIFData, type GalleryData$2 as GalleryData, type GalleryOptions$2 as GalleryOptions, type context$4_GetPublishedContentRequest as GetPublishedContentRequest, type context$4_GetPublishedContentResponse as GetPublishedContentResponse, type Gradient$2 as Gradient, type HTMLData$2 as HTMLData, type HTMLDataDataOneOf$2 as HTMLDataDataOneOf, type HeadingData$2 as HeadingData, type Height$2 as Height, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type Image$2 as Image, type ImageData$2 as ImageData, InitialExpandedItems$2 as InitialExpandedItems, type Item$2 as Item, type ItemDataOneOf$2 as ItemDataOneOf, type ItemStyle$2 as ItemStyle, type Layout$2 as Layout, LayoutType$2 as LayoutType, LineStyle$2 as LineStyle, type Link$2 as Link, type LinkData$2 as LinkData, type LinkDataOneOf$2 as LinkDataOneOf, type LinkPreviewData$2 as LinkPreviewData, type ListValue$2 as ListValue, type MapData$2 as MapData, type MapSettings$2 as MapSettings, MapType$2 as MapType, type Media$2 as Media, type MentionData$2 as MentionData, type MessageEnvelope$2 as MessageEnvelope, type Metadata$2 as Metadata, type Node$2 as Node, type NodeDataOneOf$2 as NodeDataOneOf, type NodeStyle$2 as NodeStyle, NodeType$2 as NodeType, NullValue$2 as NullValue, type Oembed$2 as Oembed, type Option$2 as Option, type OptionDesign$2 as OptionDesign, type OptionLayout$2 as OptionLayout, type OrderedListData$2 as OrderedListData, Orientation$2 as Orientation, type PDFSettings$2 as PDFSettings, type ParagraphData$2 as ParagraphData, type Permissions$2 as Permissions, type PlaybackOptions$2 as PlaybackOptions, type PluginContainerData$2 as PluginContainerData, PluginContainerDataAlignment$2 as PluginContainerDataAlignment, type PluginContainerDataWidth$2 as PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf$2 as PluginContainerDataWidthDataOneOf, type Poll$2 as Poll, type PollData$2 as PollData, type PollDataLayout$2 as PollDataLayout, type PollDesign$2 as PollDesign, type PollLayout$2 as PollLayout, PollLayoutDirection$2 as PollLayoutDirection, PollLayoutType$2 as PollLayoutType, type context$4_PublishedContent as PublishedContent, type context$4_PublishedContentField as PublishedContentField, type context$4_PublishedContentFieldValueOneOf as PublishedContentFieldValueOneOf, type context$4_PublishedContentQueryBuilder as PublishedContentQueryBuilder, type context$4_PublishedContentQueryResult as PublishedContentQueryResult, type context$4_QueryPublishedContentRequest as QueryPublishedContentRequest, type context$4_QueryPublishedContentResponse as QueryPublishedContentResponse, type context$4_QueryPublishedContentResponseNonNullableFields as QueryPublishedContentResponseNonNullableFields, type Rel$2 as Rel, type RestoreInfo$2 as RestoreInfo, type RichContent$2 as RichContent, type SchemaKey$1 as SchemaKey, SchemaScope$1 as SchemaScope, type Settings$2 as Settings, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Source$2 as Source, type Spoiler$2 as Spoiler, type SpoilerData$2 as SpoilerData, type Styles$2 as Styles, type TableCellData$2 as TableCellData, type TableData$2 as TableData, Target$2 as Target, TextAlignment$2 as TextAlignment, type TextData$2 as TextData, type TextNodeStyle$2 as TextNodeStyle, type TextStyle$2 as TextStyle, type Thumbnails$2 as Thumbnails, ThumbnailsAlignment$2 as ThumbnailsAlignment, Type$2 as Type, VerticalAlignment$2 as VerticalAlignment, type Video$2 as Video, type VideoData$2 as VideoData, type VideoResolution$1 as VideoResolution, ViewMode$2 as ViewMode, ViewRole$2 as ViewRole, VoteRole$2 as VoteRole, WebhookIdentityType$2 as WebhookIdentityType, Width$2 as Width, WidthType$2 as WidthType, type context$4__publicQueryPublishedContentType as _publicQueryPublishedContentType, context$4_queryPublishedContent as queryPublishedContent };
517
2399
  }
518
2400
 
519
2401
  /**
@@ -2413,8 +4295,62 @@ interface BulkMachineTranslateOptions {
2413
4295
  contentToTranslate?: TranslatableContent[];
2414
4296
  }
2415
4297
 
2416
- declare function machineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions) => Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
2417
- declare function bulkMachineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions) => Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
4298
+ declare function machineTranslate$1(httpClient: HttpClient): MachineTranslateSignature;
4299
+ interface MachineTranslateSignature {
4300
+ /**
4301
+ * Translates the text of a translatable unit of content from one supported language to another.
4302
+ *
4303
+ * The `translatedContent` object returns with the same `id` used for `contentToTranslate.id` but the text within the
4304
+ * content fields is replaced with the translated text. Note that Wix does not overwrite the original content object.
4305
+ * To retrieve the translated content later, make sure to store it separately.
4306
+ *
4307
+ * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
4308
+ * cannot be translated using this method.
4309
+ *
4310
+ * The translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
4311
+ * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
4312
+ * The total translatable content may be more than 5,000 characters as long as no individual node surpasses this limit.
4313
+ * If any node exceeds 5,000 characters, the entire request fails.
4314
+ *
4315
+ * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
4316
+ * Each successful translation request reduces the word credits by the number of words in `contentToTranslate`.
4317
+ * If the site does not have sufficient word credits to translate all of the text in the request, the request fails
4318
+ * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
4319
+ *
4320
+ * To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
4321
+ * @param - Language of the source text to translate.
4322
+ */
4323
+ (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions): Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
4324
+ }
4325
+ declare function bulkMachineTranslate$1(httpClient: HttpClient): BulkMachineTranslateSignature;
4326
+ interface BulkMachineTranslateSignature {
4327
+ /**
4328
+ * Translates the text of multiple units of translatable content from one supported language to another.
4329
+ *
4330
+ * Each translated content item in the `results` array returns with the same `id` as the corresponding `contentToTranslate.id`, but with the text in the
4331
+ * content fields replaced with the translated text. Note that Wix does not overwrite the original content source,
4332
+ * to retrieve the translated content later, make sure to store it separately.
4333
+ *
4334
+ * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
4335
+ * cannot be translated using this method.
4336
+ *
4337
+ * Each unit of translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
4338
+ * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
4339
+ * The total request may exceed 5,000 characters as long as no individual node surpasses this limit.
4340
+ * If any node exceeds 5,000 characters, then the request fails for that specific `contentToTranslate` item and the error details for that
4341
+ * error are returned in `itemMetadata`. Even if some translations fail due to the character limit,
4342
+ * the machine translation for other items will succeed if they are under the character limit.
4343
+ *
4344
+ * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
4345
+ * Each successful translation request reduces the word credits by the number of words included in `contentToTranslate`.
4346
+ * If the site does not have sufficient word credits to complete the translation, then the entire request fails
4347
+ * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
4348
+ *
4349
+ * To translate a single unit of `translatableContent`, use [Machine Translate](/machine-translation/machine-translate).
4350
+ * @param - Language of the source text to translate.
4351
+ */
4352
+ (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions | undefined): Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
4353
+ }
2418
4354
 
2419
4355
  declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
2420
4356
 
@@ -2770,8 +4706,22 @@ interface GetSiteTranslatablesPropertiesOptions {
2770
4706
  translatedLanguage?: Locale;
2771
4707
  }
2772
4708
 
2773
- declare function translateSite$1(httpClient: HttpClient): (mainLanguage: Locale, options: TranslateSiteOptions) => Promise<void>;
2774
- declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions) => Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
4709
+ declare function translateSite$1(httpClient: HttpClient): TranslateSiteSignature;
4710
+ interface TranslateSiteSignature {
4711
+ /**
4712
+ * Start a task to auto-translate all site content that hasn't been translated yet
4713
+ * @param - Language from which the site content is translated
4714
+ */
4715
+ (mainLanguage: Locale, options: TranslateSiteOptions): Promise<void>;
4716
+ }
4717
+ declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): GetSiteTranslatablesPropertiesSignature;
4718
+ interface GetSiteTranslatablesPropertiesSignature {
4719
+ /**
4720
+ * Receive the site's translation status
4721
+ * @param - Number of words included in main_language
4722
+ */
4723
+ (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions | undefined): Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
4724
+ }
2775
4725
 
2776
4726
  declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
2777
4727
 
@@ -4231,7 +6181,7 @@ interface QueryContentsResponse {
4231
6181
  pagingMetadata?: CursorPagingMetadata$1;
4232
6182
  }
4233
6183
  interface CursorPagingMetadata$1 {
4234
- /** Number of items returned in the response. */
6184
+ /** Number of items returned in current page. */
4235
6185
  count?: number | null;
4236
6186
  /** Cursor strings that point to the next page, previous page, or both. */
4237
6187
  cursors?: Cursors$1;
@@ -4307,6 +6257,7 @@ interface PagingMetadataV2 {
4307
6257
  cursors?: Cursors$1;
4308
6258
  }
4309
6259
  interface SearchContentsRequest {
6260
+ /** WQL expression, Aggregation and Search */
4310
6261
  search?: CursorSearch;
4311
6262
  }
4312
6263
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -5465,6 +7416,7 @@ interface ContentsQueryBuilder {
5465
7416
  find: () => Promise<ContentsQueryResult>;
5466
7417
  }
5467
7418
  interface SearchContentsOptions {
7419
+ /** WQL expression, Aggregation and Search */
5468
7420
  search?: CursorSearch;
5469
7421
  }
5470
7422
  interface BulkCreateContentOptions {
@@ -5480,17 +7432,97 @@ interface BulkUpdateContentByKeyOptions {
5480
7432
  returnEntity?: boolean;
5481
7433
  }
5482
7434
 
5483
- declare function createContent$1(httpClient: HttpClient): (content: Content) => Promise<Content & ContentNonNullableFields>;
5484
- declare function getContent$1(httpClient: HttpClient): (contentId: string) => Promise<Content & ContentNonNullableFields>;
5485
- declare function updateContent$1(httpClient: HttpClient): (_id: string | null, content: UpdateContent) => Promise<Content & ContentNonNullableFields>;
5486
- declare function updateContentByKey$1(httpClient: HttpClient): (content: Content) => Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
5487
- declare function deleteContent$1(httpClient: HttpClient): (contentId: string) => Promise<void>;
5488
- declare function queryContents$1(httpClient: HttpClient): (options?: QueryContentsOptions) => ContentsQueryBuilder;
5489
- declare function searchContents$1(httpClient: HttpClient): (options?: SearchContentsOptions) => Promise<SearchContentsResponse & SearchContentsResponseNonNullableFields>;
5490
- declare function bulkCreateContent$1(httpClient: HttpClient): (contents: Content[], options?: BulkCreateContentOptions) => Promise<BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields>;
5491
- declare function bulkUpdateContent$1(httpClient: HttpClient): (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions) => Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
5492
- declare function bulkUpdateContentByKey$1(httpClient: HttpClient): (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions) => Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
5493
- declare function bulkDeleteContent$1(httpClient: HttpClient): (contentIds: string[]) => Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
7435
+ declare function createContent$1(httpClient: HttpClient): CreateContentSignature;
7436
+ interface CreateContentSignature {
7437
+ /**
7438
+ * Creates a Content.
7439
+ *
7440
+ * The request body must include schema-id, entity-id and locale.
7441
+ * @param - Content to be created.
7442
+ * @returns The created Content.
7443
+ */
7444
+ (content: Content): Promise<Content & ContentNonNullableFields>;
7445
+ }
7446
+ declare function getContent$1(httpClient: HttpClient): GetContentSignature;
7447
+ interface GetContentSignature {
7448
+ /**
7449
+ * Retrieves a Content.
7450
+ * @param - ID of the Content to retrieve.
7451
+ * @returns The requested Content.
7452
+ */
7453
+ (contentId: string): Promise<Content & ContentNonNullableFields>;
7454
+ }
7455
+ declare function updateContent$1(httpClient: HttpClient): UpdateContentSignature;
7456
+ interface UpdateContentSignature {
7457
+ /**
7458
+ * Updates a Content.
7459
+ * @param - Content ID.
7460
+ * @returns Updated Content.
7461
+ */
7462
+ (_id: string | null, content: UpdateContent): Promise<Content & ContentNonNullableFields>;
7463
+ }
7464
+ declare function updateContentByKey$1(httpClient: HttpClient): UpdateContentByKeySignature;
7465
+ interface UpdateContentByKeySignature {
7466
+ /**
7467
+ * Updates a Content. A content is identified by a unique key, a combination of (schemaId, entityId, locale)
7468
+ * @param - Content to be updated, may be partial.
7469
+ */
7470
+ (content: Content): Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
7471
+ }
7472
+ declare function deleteContent$1(httpClient: HttpClient): DeleteContentSignature;
7473
+ interface DeleteContentSignature {
7474
+ /**
7475
+ * Deletes a Content.
7476
+ * @param - Id of the Content to delete.
7477
+ */
7478
+ (contentId: string): Promise<void>;
7479
+ }
7480
+ declare function queryContents$1(httpClient: HttpClient): QueryContentsSignature;
7481
+ interface QueryContentsSignature {
7482
+ /**
7483
+ * Retrieves a list of Contents, given the provided [paging, filtering, and sorting][1].
7484
+ */
7485
+ (options?: QueryContentsOptions | undefined): ContentsQueryBuilder;
7486
+ }
7487
+ declare function searchContents$1(httpClient: HttpClient): SearchContentsSignature;
7488
+ interface SearchContentsSignature {
7489
+ /**
7490
+ * Retrieves a list of Contents, given the provided CursorSearch.
7491
+ */
7492
+ (options?: SearchContentsOptions | undefined): Promise<SearchContentsResponse & SearchContentsResponseNonNullableFields>;
7493
+ }
7494
+ declare function bulkCreateContent$1(httpClient: HttpClient): BulkCreateContentSignature;
7495
+ interface BulkCreateContentSignature {
7496
+ /**
7497
+ * create multiple Contents in a single request. Works synchronously.
7498
+ * @param - List of Contents to be created TODO: think again if we want to increase maxSize
7499
+ */
7500
+ (contents: Content[], options?: BulkCreateContentOptions | undefined): Promise<BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields>;
7501
+ }
7502
+ declare function bulkUpdateContent$1(httpClient: HttpClient): BulkUpdateContentSignature;
7503
+ interface BulkUpdateContentSignature {
7504
+ /**
7505
+ * update multiple Contents in a single request. Works synchronously.
7506
+ * @param - Contents to be updated. TODO: think again if we want to increase maxSize
7507
+ */
7508
+ (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions | undefined): Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
7509
+ }
7510
+ declare function bulkUpdateContentByKey$1(httpClient: HttpClient): BulkUpdateContentByKeySignature;
7511
+ interface BulkUpdateContentByKeySignature {
7512
+ /**
7513
+ * update multiple Contents in a single request. Works synchronously. Each content is identified by a unique key, a combination of (schemaId, entityId, locale)
7514
+ * @param - Contents to be updated. TODO: think again if we want to increase maxSize
7515
+ */
7516
+ (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions | undefined): Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
7517
+ }
7518
+ declare function bulkDeleteContent$1(httpClient: HttpClient): BulkDeleteContentSignature;
7519
+ interface BulkDeleteContentSignature {
7520
+ /**
7521
+ * deletes multiple Contents in a single request. Works synchronously.
7522
+ * @param - Content ids to be deleted. TODO: think again if we want to increase maxSize
7523
+ */
7524
+ (contentIds: string[]): Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
7525
+ }
5494
7526
 
5495
7527
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
5496
7528
 
@@ -6569,10 +8601,36 @@ interface ListSiteSchemasOptions {
6569
8601
  paging?: CursorPaging;
6570
8602
  }
6571
8603
 
6572
- declare function getSchema$1(httpClient: HttpClient): (schemaId: string) => Promise<Schema & SchemaNonNullableFields>;
6573
- declare function getSchemaByKey$1(httpClient: HttpClient): (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey) => Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
6574
- declare function querySchemas$1(httpClient: HttpClient): (options?: QuerySchemasOptions) => SchemasQueryBuilder;
6575
- declare function listSiteSchemas$1(httpClient: HttpClient): (options?: ListSiteSchemasOptions) => Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
8604
+ declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
8605
+ interface GetSchemaSignature {
8606
+ /**
8607
+ * Retrieves a Schema.
8608
+ * @param - ID of the Schema to retrieve.
8609
+ * @returns The requested Schema.
8610
+ */
8611
+ (schemaId: string): Promise<Schema & SchemaNonNullableFields>;
8612
+ }
8613
+ declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
8614
+ interface GetSchemaByKeySignature {
8615
+ /**
8616
+ * Retrieves a Schema by key.
8617
+ */
8618
+ (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
8619
+ }
8620
+ declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
8621
+ interface QuerySchemasSignature {
8622
+ /**
8623
+ * Retrieves a list of Schemas, given the provided [paging, filtering, and sorting][1].
8624
+ */
8625
+ (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
8626
+ }
8627
+ declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
8628
+ interface ListSiteSchemasSignature {
8629
+ /**
8630
+ * Retrieves a list of Schemas of app installed on site.
8631
+ */
8632
+ (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
8633
+ }
6576
8634
  declare const onSchemaCreated$1: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
6577
8635
  declare const onSchemaUpdated$1: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
6578
8636
  declare const onSchemaDeleted$1: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
@@ -6591,12 +8649,15 @@ type _publicListSiteSchemasType = typeof listSiteSchemas$1;
6591
8649
  declare const listSiteSchemas: ReturnType<typeof createRESTModule<_publicListSiteSchemasType>>;
6592
8650
 
6593
8651
  type _publicOnSchemaCreatedType = typeof onSchemaCreated$1;
8652
+ /** */
6594
8653
  declare const onSchemaCreated: ReturnType<typeof createEventModule<_publicOnSchemaCreatedType>>;
6595
8654
 
6596
8655
  type _publicOnSchemaUpdatedType = typeof onSchemaUpdated$1;
8656
+ /** */
6597
8657
  declare const onSchemaUpdated: ReturnType<typeof createEventModule<_publicOnSchemaUpdatedType>>;
6598
8658
 
6599
8659
  type _publicOnSchemaDeletedType = typeof onSchemaDeleted$1;
8660
+ /** */
6600
8661
  declare const onSchemaDeleted: ReturnType<typeof createEventModule<_publicOnSchemaDeletedType>>;
6601
8662
 
6602
8663
  type context_ActionEvent = ActionEvent;
@@ -6703,4 +8764,4 @@ declare namespace context {
6703
8764
  export { type context_ActionEvent as ActionEvent, type context_Asset as Asset, type context_BaseEventMetadata as BaseEventMetadata, type context_CreateSchemaRequest as CreateSchemaRequest, type context_CreateSchemaResponse as CreateSchemaResponse, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_Cursors as Cursors, type context_DeleteContext as DeleteContext, type context_DeleteSchemaRequest as DeleteSchemaRequest, type context_DeleteSchemaResponse as DeleteSchemaResponse, context_DeleteStatus as DeleteStatus, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, context_FieldType as FieldType, type context_GetSchemaByKey as GetSchemaByKey, type context_GetSchemaByKeyIdentifiers as GetSchemaByKeyIdentifiers, type context_GetSchemaByKeyRequest as GetSchemaByKeyRequest, type context_GetSchemaByKeyResponse as GetSchemaByKeyResponse, type context_GetSchemaByKeyResponseNonNullableFields as GetSchemaByKeyResponseNonNullableFields, type context_GetSchemaRequest as GetSchemaRequest, type context_GetSchemaResponse as GetSchemaResponse, type context_GetSchemaResponseNonNullableFields as GetSchemaResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListSiteSchemasOptions as ListSiteSchemasOptions, type context_ListSiteSchemasRequest as ListSiteSchemasRequest, type context_ListSiteSchemasResponse as ListSiteSchemasResponse, type context_ListSiteSchemasResponseNonNullableFields as ListSiteSchemasResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, context_Namespace as Namespace, type context_NamespaceChanged as NamespaceChanged, type context_PreviewFields as PreviewFields, type context_QuerySchemasOptions as QuerySchemasOptions, type context_QuerySchemasRequest as QuerySchemasRequest, type context_QuerySchemasResponse as QuerySchemasResponse, type context_QuerySchemasResponseNonNullableFields as QuerySchemasResponseNonNullableFields, type context_RestoreInfo as RestoreInfo, type context_Schema as Schema, type context_SchemaCreatedEnvelope as SchemaCreatedEnvelope, type context_SchemaDeletedEnvelope as SchemaDeletedEnvelope, type context_SchemaField as SchemaField, type context_SchemaKey as SchemaKey, type context_SchemaNonNullableFields as SchemaNonNullableFields, context_SchemaScope as SchemaScope, type context_SchemaUpdatedEnvelope as SchemaUpdatedEnvelope, type context_SchemasQueryBuilder as SchemasQueryBuilder, type context_SchemasQueryResult as SchemasQueryResult, type context_ServiceProvisioned as ServiceProvisioned, type context_ServiceRemoved as ServiceRemoved, type context_SiteCreated as SiteCreated, context_SiteCreatedContext as SiteCreatedContext, type context_SiteDeleted as SiteDeleted, type context_SiteHardDeleted as SiteHardDeleted, type context_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type context_SitePublished as SitePublished, type context_SiteRenamed as SiteRenamed, type context_SiteTransferred as SiteTransferred, type context_SiteUndeleted as SiteUndeleted, type context_SiteUnpublished as SiteUnpublished, context_SortOrder as SortOrder, type context_Sorting as Sorting, context_State as State, type context_StudioAssigned as StudioAssigned, type context_StudioUnassigned as StudioUnassigned, type context_UpdateSchemaRequest as UpdateSchemaRequest, type context_UpdateSchemaResponse as UpdateSchemaResponse, context_WebhookIdentityType as WebhookIdentityType, type context__publicGetSchemaByKeyType as _publicGetSchemaByKeyType, type context__publicGetSchemaType as _publicGetSchemaType, type context__publicListSiteSchemasType as _publicListSiteSchemasType, type context__publicOnSchemaCreatedType as _publicOnSchemaCreatedType, type context__publicOnSchemaDeletedType as _publicOnSchemaDeletedType, type context__publicOnSchemaUpdatedType as _publicOnSchemaUpdatedType, type context__publicQuerySchemasType as _publicQuerySchemasType, context_getSchema as getSchema, context_getSchemaByKey as getSchemaByKey, context_listSiteSchemas as listSiteSchemas, context_onSchemaCreated as onSchemaCreated, context_onSchemaDeleted as onSchemaDeleted, context_onSchemaUpdated as onSchemaUpdated, onSchemaCreated$1 as publicOnSchemaCreated, onSchemaDeleted$1 as publicOnSchemaDeleted, onSchemaUpdated$1 as publicOnSchemaUpdated, context_querySchemas as querySchemas };
6704
8765
  }
6705
8766
 
6706
- export { context$4 as entityMapper, context$3 as machineTranslation, context$2 as siteTranslator, context$1 as translationContents, context as translationSchemas };
8767
+ export { context$5 as entityMapper, context$3 as machineTranslation, context$2 as siteTranslator, context$1 as translationContents, context$4 as translationPublishedContents, context as translationSchemas };