@wix/auto_sdk_data_collections 1.0.112 → 1.0.113
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +31 -31
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +157 -32
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +115 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +31 -31
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +157 -32
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +115 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +31 -31
- package/build/internal/cjs/index.typings.d.ts +86 -253
- package/build/internal/cjs/meta.d.ts +52 -209
- package/build/internal/es/index.d.mts +31 -31
- package/build/internal/es/index.typings.d.mts +86 -253
- package/build/internal/es/meta.d.mts +52 -209
- package/package.json +2 -2
|
@@ -103,7 +103,6 @@ interface DataCollection {
|
|
|
103
103
|
dataPermissions?: DataPermissions;
|
|
104
104
|
/**
|
|
105
105
|
* Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
|
|
106
|
-
* @internal
|
|
107
106
|
* @readonly
|
|
108
107
|
*/
|
|
109
108
|
allowedDataPermissions?: AllowedDataPermissions;
|
|
@@ -420,7 +419,6 @@ declare enum Type {
|
|
|
420
419
|
/**
|
|
421
420
|
* Secured media object with digital file metadata.
|
|
422
421
|
* @documentationMaturity preview
|
|
423
|
-
* @internal
|
|
424
422
|
*/
|
|
425
423
|
SECURED_MEDIA = "SECURED_MEDIA",
|
|
426
424
|
/**
|
|
@@ -435,7 +433,7 @@ declare enum Type {
|
|
|
435
433
|
MEDIA_VECTOR_ART = "MEDIA_VECTOR_ART"
|
|
436
434
|
}
|
|
437
435
|
/** @enumType */
|
|
438
|
-
type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'SLUG' | 'EMAIL' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
|
|
436
|
+
type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'SLUG' | 'EMAIL' | 'SECURED_MEDIA' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
|
|
439
437
|
interface TypeMetadata extends TypeMetadataMetadataOneOf {
|
|
440
438
|
/** Metadata for a reference field. */
|
|
441
439
|
reference?: Reference;
|
|
@@ -447,110 +445,47 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
|
|
|
447
445
|
array?: _Array;
|
|
448
446
|
/** Metadata for a page link field. */
|
|
449
447
|
pageLink?: PageLink;
|
|
450
|
-
/**
|
|
451
|
-
* Metadata for a slug field.
|
|
452
|
-
* @internal
|
|
453
|
-
*/
|
|
448
|
+
/** Metadata for a slug field. */
|
|
454
449
|
slug?: Slug;
|
|
455
|
-
/**
|
|
456
|
-
* Metadata for TEXT.
|
|
457
|
-
* @internal
|
|
458
|
-
*/
|
|
450
|
+
/** Metadata for TEXT. */
|
|
459
451
|
text?: Text;
|
|
460
|
-
/**
|
|
461
|
-
* Metadata for NUMBER.
|
|
462
|
-
* @internal
|
|
463
|
-
*/
|
|
452
|
+
/** Metadata for NUMBER. */
|
|
464
453
|
number?: _Number;
|
|
465
|
-
/**
|
|
466
|
-
* Metadata for DATE.
|
|
467
|
-
* @internal
|
|
468
|
-
*/
|
|
454
|
+
/** Metadata for DATE. */
|
|
469
455
|
date?: _Date;
|
|
470
|
-
/**
|
|
471
|
-
* Metadata for DATETIME.
|
|
472
|
-
* @internal
|
|
473
|
-
*/
|
|
456
|
+
/** Metadata for DATETIME. */
|
|
474
457
|
datetime?: Datetime;
|
|
475
|
-
/**
|
|
476
|
-
* Metadata for IMAGE.
|
|
477
|
-
* @internal
|
|
478
|
-
*/
|
|
458
|
+
/** Metadata for IMAGE. */
|
|
479
459
|
image?: Image;
|
|
480
|
-
/**
|
|
481
|
-
* Metadata for BOOLEAN.
|
|
482
|
-
* @internal
|
|
483
|
-
*/
|
|
460
|
+
/** Metadata for BOOLEAN. */
|
|
484
461
|
boolean?: _Boolean;
|
|
485
|
-
/**
|
|
486
|
-
* Metadata for DOCUMENT.
|
|
487
|
-
* @internal
|
|
488
|
-
*/
|
|
462
|
+
/** Metadata for DOCUMENT. */
|
|
489
463
|
document?: Document;
|
|
490
|
-
/**
|
|
491
|
-
* Metadata for URL.
|
|
492
|
-
* @internal
|
|
493
|
-
*/
|
|
464
|
+
/** Metadata for URL. */
|
|
494
465
|
url?: Url;
|
|
495
|
-
/**
|
|
496
|
-
* Metadata for RICH_TEXT.
|
|
497
|
-
* @internal
|
|
498
|
-
*/
|
|
466
|
+
/** Metadata for RICH_TEXT. */
|
|
499
467
|
richText?: RichText;
|
|
500
|
-
/**
|
|
501
|
-
* Metadata for VIDEO.
|
|
502
|
-
* @internal
|
|
503
|
-
*/
|
|
468
|
+
/** Metadata for VIDEO. */
|
|
504
469
|
video?: Video;
|
|
505
|
-
/**
|
|
506
|
-
* Metadata for ARRAY_STRING.
|
|
507
|
-
* @internal
|
|
508
|
-
*/
|
|
470
|
+
/** Metadata for ARRAY_STRING. */
|
|
509
471
|
arrayString?: ArrayString;
|
|
510
|
-
/**
|
|
511
|
-
* Metadata for ARRAY_DOCUMENT.
|
|
512
|
-
* @internal
|
|
513
|
-
*/
|
|
472
|
+
/** Metadata for ARRAY_DOCUMENT. */
|
|
514
473
|
arrayDocument?: ArrayDocument;
|
|
515
|
-
/**
|
|
516
|
-
* Metadata for AUDIO.
|
|
517
|
-
* @internal
|
|
518
|
-
*/
|
|
474
|
+
/** Metadata for AUDIO. */
|
|
519
475
|
audio?: Audio;
|
|
520
|
-
/**
|
|
521
|
-
* Metadata for TIME.
|
|
522
|
-
* @internal
|
|
523
|
-
*/
|
|
476
|
+
/** Metadata for TIME. */
|
|
524
477
|
time?: Time;
|
|
525
|
-
/**
|
|
526
|
-
* Metadata for RICH_CONTENT.
|
|
527
|
-
* @internal
|
|
528
|
-
*/
|
|
478
|
+
/** Metadata for RICH_CONTENT. */
|
|
529
479
|
richContent?: RichContent;
|
|
530
|
-
/**
|
|
531
|
-
* Metadata for MEDIA_GALLERY.
|
|
532
|
-
* @internal
|
|
533
|
-
*/
|
|
480
|
+
/** Metadata for MEDIA_GALLERY. */
|
|
534
481
|
mediaGallery?: MediaGallery;
|
|
535
|
-
/**
|
|
536
|
-
* Metadata for ADDRESS.
|
|
537
|
-
* @internal
|
|
538
|
-
*/
|
|
482
|
+
/** Metadata for ADDRESS. */
|
|
539
483
|
address?: Address;
|
|
540
|
-
/**
|
|
541
|
-
* Metadata for EMAIL.
|
|
542
|
-
* @internal
|
|
543
|
-
*/
|
|
484
|
+
/** Metadata for EMAIL. */
|
|
544
485
|
email?: Email;
|
|
545
|
-
/**
|
|
546
|
-
* Metadata for LEGACY_COLOR.
|
|
547
|
-
* @internal
|
|
548
|
-
*/
|
|
486
|
+
/** Metadata for LEGACY_COLOR. */
|
|
549
487
|
legacyColor?: LegacyColor;
|
|
550
|
-
/**
|
|
551
|
-
* Metadata for MEDIA_IMAGE.
|
|
552
|
-
* @internal
|
|
553
|
-
*/
|
|
488
|
+
/** Metadata for MEDIA_IMAGE. */
|
|
554
489
|
mediaImage?: MediaImage;
|
|
555
490
|
}
|
|
556
491
|
/** @oneof */
|
|
@@ -565,110 +500,47 @@ interface TypeMetadataMetadataOneOf {
|
|
|
565
500
|
array?: _Array;
|
|
566
501
|
/** Metadata for a page link field. */
|
|
567
502
|
pageLink?: PageLink;
|
|
568
|
-
/**
|
|
569
|
-
* Metadata for a slug field.
|
|
570
|
-
* @internal
|
|
571
|
-
*/
|
|
503
|
+
/** Metadata for a slug field. */
|
|
572
504
|
slug?: Slug;
|
|
573
|
-
/**
|
|
574
|
-
* Metadata for TEXT.
|
|
575
|
-
* @internal
|
|
576
|
-
*/
|
|
505
|
+
/** Metadata for TEXT. */
|
|
577
506
|
text?: Text;
|
|
578
|
-
/**
|
|
579
|
-
* Metadata for NUMBER.
|
|
580
|
-
* @internal
|
|
581
|
-
*/
|
|
507
|
+
/** Metadata for NUMBER. */
|
|
582
508
|
number?: _Number;
|
|
583
|
-
/**
|
|
584
|
-
* Metadata for DATE.
|
|
585
|
-
* @internal
|
|
586
|
-
*/
|
|
509
|
+
/** Metadata for DATE. */
|
|
587
510
|
date?: _Date;
|
|
588
|
-
/**
|
|
589
|
-
* Metadata for DATETIME.
|
|
590
|
-
* @internal
|
|
591
|
-
*/
|
|
511
|
+
/** Metadata for DATETIME. */
|
|
592
512
|
datetime?: Datetime;
|
|
593
|
-
/**
|
|
594
|
-
* Metadata for IMAGE.
|
|
595
|
-
* @internal
|
|
596
|
-
*/
|
|
513
|
+
/** Metadata for IMAGE. */
|
|
597
514
|
image?: Image;
|
|
598
|
-
/**
|
|
599
|
-
* Metadata for BOOLEAN.
|
|
600
|
-
* @internal
|
|
601
|
-
*/
|
|
515
|
+
/** Metadata for BOOLEAN. */
|
|
602
516
|
boolean?: _Boolean;
|
|
603
|
-
/**
|
|
604
|
-
* Metadata for DOCUMENT.
|
|
605
|
-
* @internal
|
|
606
|
-
*/
|
|
517
|
+
/** Metadata for DOCUMENT. */
|
|
607
518
|
document?: Document;
|
|
608
|
-
/**
|
|
609
|
-
* Metadata for URL.
|
|
610
|
-
* @internal
|
|
611
|
-
*/
|
|
519
|
+
/** Metadata for URL. */
|
|
612
520
|
url?: Url;
|
|
613
|
-
/**
|
|
614
|
-
* Metadata for RICH_TEXT.
|
|
615
|
-
* @internal
|
|
616
|
-
*/
|
|
521
|
+
/** Metadata for RICH_TEXT. */
|
|
617
522
|
richText?: RichText;
|
|
618
|
-
/**
|
|
619
|
-
* Metadata for VIDEO.
|
|
620
|
-
* @internal
|
|
621
|
-
*/
|
|
523
|
+
/** Metadata for VIDEO. */
|
|
622
524
|
video?: Video;
|
|
623
|
-
/**
|
|
624
|
-
* Metadata for ARRAY_STRING.
|
|
625
|
-
* @internal
|
|
626
|
-
*/
|
|
525
|
+
/** Metadata for ARRAY_STRING. */
|
|
627
526
|
arrayString?: ArrayString;
|
|
628
|
-
/**
|
|
629
|
-
* Metadata for ARRAY_DOCUMENT.
|
|
630
|
-
* @internal
|
|
631
|
-
*/
|
|
527
|
+
/** Metadata for ARRAY_DOCUMENT. */
|
|
632
528
|
arrayDocument?: ArrayDocument;
|
|
633
|
-
/**
|
|
634
|
-
* Metadata for AUDIO.
|
|
635
|
-
* @internal
|
|
636
|
-
*/
|
|
529
|
+
/** Metadata for AUDIO. */
|
|
637
530
|
audio?: Audio;
|
|
638
|
-
/**
|
|
639
|
-
* Metadata for TIME.
|
|
640
|
-
* @internal
|
|
641
|
-
*/
|
|
531
|
+
/** Metadata for TIME. */
|
|
642
532
|
time?: Time;
|
|
643
|
-
/**
|
|
644
|
-
* Metadata for RICH_CONTENT.
|
|
645
|
-
* @internal
|
|
646
|
-
*/
|
|
533
|
+
/** Metadata for RICH_CONTENT. */
|
|
647
534
|
richContent?: RichContent;
|
|
648
|
-
/**
|
|
649
|
-
* Metadata for MEDIA_GALLERY.
|
|
650
|
-
* @internal
|
|
651
|
-
*/
|
|
535
|
+
/** Metadata for MEDIA_GALLERY. */
|
|
652
536
|
mediaGallery?: MediaGallery;
|
|
653
|
-
/**
|
|
654
|
-
* Metadata for ADDRESS.
|
|
655
|
-
* @internal
|
|
656
|
-
*/
|
|
537
|
+
/** Metadata for ADDRESS. */
|
|
657
538
|
address?: Address;
|
|
658
|
-
/**
|
|
659
|
-
* Metadata for EMAIL.
|
|
660
|
-
* @internal
|
|
661
|
-
*/
|
|
539
|
+
/** Metadata for EMAIL. */
|
|
662
540
|
email?: Email;
|
|
663
|
-
/**
|
|
664
|
-
* Metadata for LEGACY_COLOR.
|
|
665
|
-
* @internal
|
|
666
|
-
*/
|
|
541
|
+
/** Metadata for LEGACY_COLOR. */
|
|
667
542
|
legacyColor?: LegacyColor;
|
|
668
|
-
/**
|
|
669
|
-
* Metadata for MEDIA_IMAGE.
|
|
670
|
-
* @internal
|
|
671
|
-
*/
|
|
543
|
+
/** Metadata for MEDIA_IMAGE. */
|
|
672
544
|
mediaImage?: MediaImage;
|
|
673
545
|
}
|
|
674
546
|
interface FieldCapabilities {
|
|
@@ -804,10 +676,7 @@ interface _Object {
|
|
|
804
676
|
* @maxSize 1000
|
|
805
677
|
*/
|
|
806
678
|
fields?: ObjectField[];
|
|
807
|
-
/**
|
|
808
|
-
* Value assigned when a data item omits this field.
|
|
809
|
-
* @internal
|
|
810
|
-
*/
|
|
679
|
+
/** Value assigned when a data item omits this field. */
|
|
811
680
|
defaultValue?: Record<string, any> | null;
|
|
812
681
|
}
|
|
813
682
|
interface _Array {
|
|
@@ -815,17 +684,10 @@ interface _Array {
|
|
|
815
684
|
elementType?: TypeWithLiterals;
|
|
816
685
|
/** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
|
|
817
686
|
typeMetadata?: TypeMetadata;
|
|
818
|
-
/**
|
|
819
|
-
* Minimum permitted number of items in an array field.
|
|
820
|
-
* @internal
|
|
821
|
-
*/
|
|
687
|
+
/** Minimum permitted number of items in an array field. */
|
|
822
688
|
minSize?: number | null;
|
|
823
|
-
/**
|
|
824
|
-
* Maximum permitted number of items in an array field.
|
|
825
|
-
* @internal
|
|
826
|
-
*/
|
|
689
|
+
/** Maximum permitted number of items in an array field. */
|
|
827
690
|
maxSize?: number | null;
|
|
828
|
-
/** @internal */
|
|
829
691
|
defaultValue?: any[];
|
|
830
692
|
}
|
|
831
693
|
interface PageLink {
|
|
@@ -836,10 +698,7 @@ interface PageLink {
|
|
|
836
698
|
* @maxLength 1000
|
|
837
699
|
*/
|
|
838
700
|
linkedRouterPage?: string | null;
|
|
839
|
-
/**
|
|
840
|
-
* Defines the type of the page link.
|
|
841
|
-
* @internal
|
|
842
|
-
*/
|
|
701
|
+
/** Defines the type of the page link. */
|
|
843
702
|
pageLinkType?: PageLinkTypeWithLiterals;
|
|
844
703
|
}
|
|
845
704
|
interface Slug {
|
|
@@ -849,17 +708,10 @@ interface Slug {
|
|
|
849
708
|
* @maxLength 1000
|
|
850
709
|
*/
|
|
851
710
|
pattern?: string;
|
|
852
|
-
/**
|
|
853
|
-
* Minimum permitted length for a string field.
|
|
854
|
-
* @internal
|
|
855
|
-
*/
|
|
711
|
+
/** Minimum permitted length for a string field. */
|
|
856
712
|
minLength?: number | null;
|
|
857
|
-
/**
|
|
858
|
-
* Maximum permitted length for a string field.
|
|
859
|
-
* @internal
|
|
860
|
-
*/
|
|
713
|
+
/** Maximum permitted length for a string field. */
|
|
861
714
|
maxLength?: number | null;
|
|
862
|
-
/** @internal */
|
|
863
715
|
defaultValue?: string | null;
|
|
864
716
|
}
|
|
865
717
|
interface Text extends TextValidationOneOf {
|
|
@@ -1766,10 +1618,7 @@ interface GetDataCollectionRequest {
|
|
|
1766
1618
|
* @internal
|
|
1767
1619
|
*/
|
|
1768
1620
|
includeDeletedFields?: boolean;
|
|
1769
|
-
/**
|
|
1770
|
-
* If set allowed for caller data permissions would be included in the response
|
|
1771
|
-
* @internal
|
|
1772
|
-
*/
|
|
1621
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1773
1622
|
includeAllowedDataPermissions?: boolean;
|
|
1774
1623
|
/**
|
|
1775
1624
|
* Segment: PUBLIC or DEV.
|
|
@@ -1826,10 +1675,7 @@ interface ListDataCollectionsRequest {
|
|
|
1826
1675
|
* Default: `false`
|
|
1827
1676
|
*/
|
|
1828
1677
|
consistentRead?: boolean;
|
|
1829
|
-
/**
|
|
1830
|
-
* If set allowed for caller data permissions would be included in the response
|
|
1831
|
-
* @internal
|
|
1832
|
-
*/
|
|
1678
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1833
1679
|
includeAllowedDataPermissions?: boolean;
|
|
1834
1680
|
/**
|
|
1835
1681
|
* Segment: PUBLIC or DEV.
|
|
@@ -1927,10 +1773,7 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1927
1773
|
* Default: `false`
|
|
1928
1774
|
*/
|
|
1929
1775
|
consistentRead?: boolean;
|
|
1930
|
-
/**
|
|
1931
|
-
* If set allowed for caller data permissions would be included in the response
|
|
1932
|
-
* @internal
|
|
1933
|
-
*/
|
|
1776
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1934
1777
|
includeAllowedDataPermissions?: boolean;
|
|
1935
1778
|
/**
|
|
1936
1779
|
* Segment: PUBLIC or DEV.
|
|
@@ -2909,7 +2752,7 @@ interface AccountInfo {
|
|
|
2909
2752
|
* @returns Created collection.
|
|
2910
2753
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
|
|
2911
2754
|
*/
|
|
2912
|
-
declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
2755
|
+
declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.typeMetadata.pageLink.pageLinkType` | `fields.${number}.typeMetadata.slug.pattern` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
2913
2756
|
/**
|
|
2914
2757
|
* Retrieves a data collection by ID.
|
|
2915
2758
|
*
|
|
@@ -2928,7 +2771,7 @@ declare function createDataCollection(collection: NonNullablePaths<DataCollectio
|
|
|
2928
2771
|
* @returns Requested collection.
|
|
2929
2772
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
|
|
2930
2773
|
*/
|
|
2931
|
-
declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
2774
|
+
declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.typeMetadata.pageLink.pageLinkType` | `fields.${number}.typeMetadata.slug.pattern` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
2932
2775
|
interface GetDataCollectionOptions {
|
|
2933
2776
|
/**
|
|
2934
2777
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -2938,10 +2781,7 @@ interface GetDataCollectionOptions {
|
|
|
2938
2781
|
* Default: `false`
|
|
2939
2782
|
*/
|
|
2940
2783
|
consistentRead?: boolean;
|
|
2941
|
-
/**
|
|
2942
|
-
* If set allowed for caller data permissions would be included in the response
|
|
2943
|
-
* @internal
|
|
2944
|
-
*/
|
|
2784
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2945
2785
|
includeAllowedDataPermissions?: boolean;
|
|
2946
2786
|
/**
|
|
2947
2787
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
@@ -2964,7 +2804,7 @@ interface GetDataCollectionOptions {
|
|
|
2964
2804
|
* @applicableIdentity APP
|
|
2965
2805
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.ListDataCollections
|
|
2966
2806
|
*/
|
|
2967
|
-
declare function listDataCollections(options?: ListDataCollectionsOptions): Promise<NonNullablePaths<ListDataCollectionsResponse, `collections` | `collections.${number}._id` | `collections.${number}.collectionType` | `collections.${number}.defaultDisplayOrder.fieldKey` | `collections.${number}.defaultDisplayOrder.direction` | `collections.${number}.capabilities.indexLimits.regular` | `collections.${number}.capabilities.indexLimits.unique` | `collections.${number}.capabilities.indexLimits.total` | `collections.${number}.permissions.insert` | `collections.${number}.permissions.update` | `collections.${number}.permissions.remove` | `collections.${number}.permissions.read` | `collections.${number}.deprecation.deprecated`, 4>>;
|
|
2807
|
+
declare function listDataCollections(options?: ListDataCollectionsOptions): Promise<NonNullablePaths<ListDataCollectionsResponse, `collections` | `collections.${number}._id` | `collections.${number}.collectionType` | `collections.${number}.defaultDisplayOrder.fieldKey` | `collections.${number}.defaultDisplayOrder.direction` | `collections.${number}.capabilities.indexLimits.regular` | `collections.${number}.capabilities.indexLimits.unique` | `collections.${number}.capabilities.indexLimits.total` | `collections.${number}.permissions.insert` | `collections.${number}.permissions.update` | `collections.${number}.permissions.remove` | `collections.${number}.permissions.read` | `collections.${number}.allowedDataPermissions.itemRead` | `collections.${number}.allowedDataPermissions.itemInsert` | `collections.${number}.allowedDataPermissions.itemUpdate` | `collections.${number}.allowedDataPermissions.itemRemove` | `collections.${number}.deprecation.deprecated`, 4>>;
|
|
2968
2808
|
interface ListDataCollectionsOptions {
|
|
2969
2809
|
/**
|
|
2970
2810
|
* Defines how collections in the response are sorted.
|
|
@@ -2988,10 +2828,7 @@ interface ListDataCollectionsOptions {
|
|
|
2988
2828
|
* Default: `false`
|
|
2989
2829
|
*/
|
|
2990
2830
|
consistentRead?: boolean;
|
|
2991
|
-
/**
|
|
2992
|
-
* If set allowed for caller data permissions would be included in the response
|
|
2993
|
-
* @internal
|
|
2994
|
-
*/
|
|
2831
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2995
2832
|
includeAllowedDataPermissions?: boolean;
|
|
2996
2833
|
/**
|
|
2997
2834
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
@@ -3021,7 +2858,7 @@ interface ListDataCollectionsOptions {
|
|
|
3021
2858
|
* @applicableIdentity APP
|
|
3022
2859
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.BulkGetDataCollections
|
|
3023
2860
|
*/
|
|
3024
|
-
declare function bulkGetDataCollections(options?: BulkGetDataCollectionsOptions): Promise<NonNullablePaths<BulkGetDataCollectionsResponse, `activeCollections` | `activeCollections.${number}._id` | `activeCollections.${number}.collectionType` | `activeCollections.${number}.defaultDisplayOrder.fieldKey` | `activeCollections.${number}.defaultDisplayOrder.direction` | `activeCollections.${number}.capabilities.indexLimits.regular` | `activeCollections.${number}.capabilities.indexLimits.unique` | `activeCollections.${number}.capabilities.indexLimits.total` | `activeCollections.${number}.permissions.insert` | `activeCollections.${number}.permissions.update` | `activeCollections.${number}.permissions.remove` | `activeCollections.${number}.permissions.read` | `activeCollections.${number}.deprecation.deprecated` | `deletedCollections` | `deletedCollections.${number}._id` | `deletedCollections.${number}.collectionType` | `deletedCollections.${number}.defaultDisplayOrder.fieldKey` | `deletedCollections.${number}.defaultDisplayOrder.direction` | `deletedCollections.${number}.capabilities.indexLimits.regular` | `deletedCollections.${number}.capabilities.indexLimits.unique` | `deletedCollections.${number}.capabilities.indexLimits.total` | `deletedCollections.${number}.permissions.insert` | `deletedCollections.${number}.permissions.update` | `deletedCollections.${number}.permissions.remove` | `deletedCollections.${number}.permissions.read` | `deletedCollections.${number}.deprecation.deprecated` | `failedCollections` | `failedCollections.${number}.collectionId` | `failedCollections.${number}.error.code` | `failedCollections.${number}.error.description`, 4>>;
|
|
2861
|
+
declare function bulkGetDataCollections(options?: BulkGetDataCollectionsOptions): Promise<NonNullablePaths<BulkGetDataCollectionsResponse, `activeCollections` | `activeCollections.${number}._id` | `activeCollections.${number}.collectionType` | `activeCollections.${number}.defaultDisplayOrder.fieldKey` | `activeCollections.${number}.defaultDisplayOrder.direction` | `activeCollections.${number}.capabilities.indexLimits.regular` | `activeCollections.${number}.capabilities.indexLimits.unique` | `activeCollections.${number}.capabilities.indexLimits.total` | `activeCollections.${number}.permissions.insert` | `activeCollections.${number}.permissions.update` | `activeCollections.${number}.permissions.remove` | `activeCollections.${number}.permissions.read` | `activeCollections.${number}.allowedDataPermissions.itemRead` | `activeCollections.${number}.allowedDataPermissions.itemInsert` | `activeCollections.${number}.allowedDataPermissions.itemUpdate` | `activeCollections.${number}.allowedDataPermissions.itemRemove` | `activeCollections.${number}.deprecation.deprecated` | `deletedCollections` | `deletedCollections.${number}._id` | `deletedCollections.${number}.collectionType` | `deletedCollections.${number}.defaultDisplayOrder.fieldKey` | `deletedCollections.${number}.defaultDisplayOrder.direction` | `deletedCollections.${number}.capabilities.indexLimits.regular` | `deletedCollections.${number}.capabilities.indexLimits.unique` | `deletedCollections.${number}.capabilities.indexLimits.total` | `deletedCollections.${number}.permissions.insert` | `deletedCollections.${number}.permissions.update` | `deletedCollections.${number}.permissions.remove` | `deletedCollections.${number}.permissions.read` | `deletedCollections.${number}.allowedDataPermissions.itemRead` | `deletedCollections.${number}.allowedDataPermissions.itemInsert` | `deletedCollections.${number}.allowedDataPermissions.itemUpdate` | `deletedCollections.${number}.allowedDataPermissions.itemRemove` | `deletedCollections.${number}.deprecation.deprecated` | `failedCollections` | `failedCollections.${number}.collectionId` | `failedCollections.${number}.error.code` | `failedCollections.${number}.error.description`, 4>>;
|
|
3025
2862
|
interface BulkGetDataCollectionsOptions {
|
|
3026
2863
|
/**
|
|
3027
2864
|
* IDs of the collections to retrieve.
|
|
@@ -3058,10 +2895,7 @@ interface BulkGetDataCollectionsOptions {
|
|
|
3058
2895
|
* Default: `false`
|
|
3059
2896
|
*/
|
|
3060
2897
|
consistentRead?: boolean;
|
|
3061
|
-
/**
|
|
3062
|
-
* If set allowed for caller data permissions would be included in the response
|
|
3063
|
-
* @internal
|
|
3064
|
-
*/
|
|
2898
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
3065
2899
|
includeAllowedDataPermissions?: boolean;
|
|
3066
2900
|
/**
|
|
3067
2901
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
@@ -3110,7 +2944,7 @@ interface BulkGetDataCollectionsOptions {
|
|
|
3110
2944
|
* @returns Updated collection details.
|
|
3111
2945
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollection
|
|
3112
2946
|
*/
|
|
3113
|
-
declare function updateDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update` | `revision`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
2947
|
+
declare function updateDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update` | `revision`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.typeMetadata.pageLink.pageLinkType` | `fields.${number}.typeMetadata.slug.pattern` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
3114
2948
|
/**
|
|
3115
2949
|
* Deletes a data collection.
|
|
3116
2950
|
*
|
|
@@ -3141,7 +2975,7 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
|
|
|
3141
2975
|
* @applicableIdentity APP
|
|
3142
2976
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection
|
|
3143
2977
|
*/
|
|
3144
|
-
declare function restoreDataCollection(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2978
|
+
declare function restoreDataCollection(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3145
2979
|
/**
|
|
3146
2980
|
* Updates specified properties of a data collection.
|
|
3147
2981
|
*
|
|
@@ -3160,7 +2994,7 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
|
|
|
3160
2994
|
* @applicableIdentity APP
|
|
3161
2995
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
|
|
3162
2996
|
*/
|
|
3163
|
-
declare function patchDataCollection(_id: string, dataCollection: PatchDataCollection): Promise<NonNullablePaths<PatchDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2997
|
+
declare function patchDataCollection(_id: string, dataCollection: PatchDataCollection): Promise<NonNullablePaths<PatchDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3164
2998
|
interface PatchDataCollection {
|
|
3165
2999
|
/**
|
|
3166
3000
|
* [Collection ID](https://dev.wix.com/docs/develop-websites-sdk/code-your-site/work-with-data/introduction/about-collections#collection-ids). For example, `my-first-collection`.
|
|
@@ -3260,7 +3094,6 @@ interface PatchDataCollection {
|
|
|
3260
3094
|
dataPermissions?: DataPermissions;
|
|
3261
3095
|
/**
|
|
3262
3096
|
* Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
|
|
3263
|
-
* @internal
|
|
3264
3097
|
* @readonly
|
|
3265
3098
|
*/
|
|
3266
3099
|
allowedDataPermissions?: AllowedDataPermissions;
|
|
@@ -3295,7 +3128,7 @@ interface PatchDataCollection {
|
|
|
3295
3128
|
* @applicableIdentity APP
|
|
3296
3129
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollectionField
|
|
3297
3130
|
*/
|
|
3298
|
-
declare function createDataCollectionField(dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3131
|
+
declare function createDataCollectionField(dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3299
3132
|
interface CreateDataCollectionFieldOptions {
|
|
3300
3133
|
/** New field to add. */
|
|
3301
3134
|
field: Field;
|
|
@@ -3322,7 +3155,7 @@ interface CreateDataCollectionFieldOptions {
|
|
|
3322
3155
|
* @applicableIdentity APP
|
|
3323
3156
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollectionField
|
|
3324
3157
|
*/
|
|
3325
|
-
declare function updateDataCollectionField(dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3158
|
+
declare function updateDataCollectionField(dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3326
3159
|
interface UpdateDataCollectionFieldOptions {
|
|
3327
3160
|
/** Field to update. */
|
|
3328
3161
|
field: Field;
|
|
@@ -3341,7 +3174,7 @@ interface UpdateDataCollectionFieldOptions {
|
|
|
3341
3174
|
* @applicableIdentity APP
|
|
3342
3175
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionField
|
|
3343
3176
|
*/
|
|
3344
|
-
declare function deleteDataCollectionField(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`, 0>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3177
|
+
declare function deleteDataCollectionField(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`, 0>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3345
3178
|
interface DeleteDataCollectionFieldOptions {
|
|
3346
3179
|
/**
|
|
3347
3180
|
* ID of the field to delete.
|
|
@@ -3363,7 +3196,7 @@ interface DeleteDataCollectionFieldOptions {
|
|
|
3363
3196
|
* @applicableIdentity APP
|
|
3364
3197
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDataCollectionPlugin
|
|
3365
3198
|
*/
|
|
3366
|
-
declare function addDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<AddDataCollectionPluginOptions, `plugin` | `plugin.type`, 1>): Promise<NonNullablePaths<AddDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3199
|
+
declare function addDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<AddDataCollectionPluginOptions, `plugin` | `plugin.type`, 1>): Promise<NonNullablePaths<AddDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3367
3200
|
interface AddDataCollectionPluginOptions {
|
|
3368
3201
|
/**
|
|
3369
3202
|
* Plugin to add to the collection. Must include the plugin type and any type-specific configuration.
|
|
@@ -3384,7 +3217,7 @@ interface AddDataCollectionPluginOptions {
|
|
|
3384
3217
|
* @applicableIdentity APP
|
|
3385
3218
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionPlugin
|
|
3386
3219
|
*/
|
|
3387
|
-
declare function deleteDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionPluginOptions, `pluginType`, 0>): Promise<NonNullablePaths<DeleteDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3220
|
+
declare function deleteDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionPluginOptions, `pluginType`, 0>): Promise<NonNullablePaths<DeleteDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3388
3221
|
interface DeleteDataCollectionPluginOptions {
|
|
3389
3222
|
/** Plugin type to remove. */
|
|
3390
3223
|
pluginType: PluginTypeWithLiterals;
|
|
@@ -3404,7 +3237,7 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
3404
3237
|
* @applicableIdentity APP
|
|
3405
3238
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddPublishPlugin
|
|
3406
3239
|
*/
|
|
3407
|
-
declare function addPublishPlugin(dataCollectionId: string, options?: NonNullablePaths<AddPublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<AddPublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3240
|
+
declare function addPublishPlugin(dataCollectionId: string, options?: NonNullablePaths<AddPublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<AddPublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3408
3241
|
interface AddPublishPluginOptions {
|
|
3409
3242
|
/** Publish plugin options. */
|
|
3410
3243
|
publishOptions: PublishPluginOptions;
|
|
@@ -3427,7 +3260,7 @@ interface AddPublishPluginOptions {
|
|
|
3427
3260
|
* @applicableIdentity APP
|
|
3428
3261
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeletePublishPlugin
|
|
3429
3262
|
*/
|
|
3430
|
-
declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3263
|
+
declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3431
3264
|
/**
|
|
3432
3265
|
* Updates the Publish plugin options on a data collection.
|
|
3433
3266
|
*
|
|
@@ -3443,7 +3276,7 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3443
3276
|
* @applicableIdentity APP
|
|
3444
3277
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdatePublishPlugin
|
|
3445
3278
|
*/
|
|
3446
|
-
declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3279
|
+
declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3447
3280
|
interface UpdatePublishPluginOptions {
|
|
3448
3281
|
/**
|
|
3449
3282
|
* Replacement writable options for the Publish plugin. Omitted options use their defaults.
|
|
@@ -3466,7 +3299,7 @@ interface UpdatePublishPluginOptions {
|
|
|
3466
3299
|
* @applicableIdentity APP
|
|
3467
3300
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddUrlizedPlugin
|
|
3468
3301
|
*/
|
|
3469
|
-
declare function addUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<AddUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<AddUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3302
|
+
declare function addUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<AddUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<AddUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3470
3303
|
interface AddUrlizedPluginOptions {
|
|
3471
3304
|
/** Urlized plugin options. */
|
|
3472
3305
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3483,7 +3316,7 @@ interface AddUrlizedPluginOptions {
|
|
|
3483
3316
|
* @applicableIdentity APP
|
|
3484
3317
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteUrlizedPlugin
|
|
3485
3318
|
*/
|
|
3486
|
-
declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3319
|
+
declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3487
3320
|
/**
|
|
3488
3321
|
* Updates the Urlized plugin options on a data collection.
|
|
3489
3322
|
*
|
|
@@ -3499,7 +3332,7 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3499
3332
|
* @applicableIdentity APP
|
|
3500
3333
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateUrlizedPlugin
|
|
3501
3334
|
*/
|
|
3502
|
-
declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3335
|
+
declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3503
3336
|
interface UpdateUrlizedPluginOptions {
|
|
3504
3337
|
/** Replacement options for the Urlized plugin. Omitted options use their defaults. */
|
|
3505
3338
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3519,7 +3352,7 @@ interface UpdateUrlizedPluginOptions {
|
|
|
3519
3352
|
* @applicableIdentity APP
|
|
3520
3353
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddMultilingualPlugin
|
|
3521
3354
|
*/
|
|
3522
|
-
declare function addMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<AddMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<AddMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3355
|
+
declare function addMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<AddMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<AddMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3523
3356
|
interface AddMultilingualPluginOptions {
|
|
3524
3357
|
/** Multilingual plugin options. */
|
|
3525
3358
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3536,7 +3369,7 @@ interface AddMultilingualPluginOptions {
|
|
|
3536
3369
|
* @applicableIdentity APP
|
|
3537
3370
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteMultilingualPlugin
|
|
3538
3371
|
*/
|
|
3539
|
-
declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3372
|
+
declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3540
3373
|
/**
|
|
3541
3374
|
* Updates the Multilingual plugin options on a data collection.
|
|
3542
3375
|
*
|
|
@@ -3552,7 +3385,7 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
|
|
|
3552
3385
|
* @applicableIdentity APP
|
|
3553
3386
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateMultilingualPlugin
|
|
3554
3387
|
*/
|
|
3555
|
-
declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3388
|
+
declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3556
3389
|
interface UpdateMultilingualPluginOptions {
|
|
3557
3390
|
/** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
|
|
3558
3391
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3572,7 +3405,7 @@ interface UpdateMultilingualPluginOptions {
|
|
|
3572
3405
|
* @applicableIdentity APP
|
|
3573
3406
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCmsPlugin
|
|
3574
3407
|
*/
|
|
3575
|
-
declare function addCmsPlugin(dataCollectionId: string, options: NonNullablePaths<AddCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<AddCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3408
|
+
declare function addCmsPlugin(dataCollectionId: string, options: NonNullablePaths<AddCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<AddCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3576
3409
|
interface AddCmsPluginOptions {
|
|
3577
3410
|
/** CMS plugin options. */
|
|
3578
3411
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3589,7 +3422,7 @@ interface AddCmsPluginOptions {
|
|
|
3589
3422
|
* @applicableIdentity APP
|
|
3590
3423
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCmsPlugin
|
|
3591
3424
|
*/
|
|
3592
|
-
declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3425
|
+
declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3593
3426
|
/**
|
|
3594
3427
|
* Updates the CMS plugin options on a data collection.
|
|
3595
3428
|
*
|
|
@@ -3605,7 +3438,7 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
|
|
|
3605
3438
|
* @applicableIdentity APP
|
|
3606
3439
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCmsPlugin
|
|
3607
3440
|
*/
|
|
3608
|
-
declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3441
|
+
declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3609
3442
|
interface UpdateCmsPluginOptions {
|
|
3610
3443
|
/** Replacement options for the CMS plugin. Omitted options use their defaults. */
|
|
3611
3444
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3625,7 +3458,7 @@ interface UpdateCmsPluginOptions {
|
|
|
3625
3458
|
* @applicableIdentity APP
|
|
3626
3459
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCatalogPlugin
|
|
3627
3460
|
*/
|
|
3628
|
-
declare function addCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<AddCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<AddCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3461
|
+
declare function addCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<AddCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<AddCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3629
3462
|
interface AddCatalogPluginOptions {
|
|
3630
3463
|
/** Catalog plugin options. */
|
|
3631
3464
|
catalogOptions: CatalogOptions;
|
|
@@ -3642,7 +3475,7 @@ interface AddCatalogPluginOptions {
|
|
|
3642
3475
|
* @applicableIdentity APP
|
|
3643
3476
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCatalogPlugin
|
|
3644
3477
|
*/
|
|
3645
|
-
declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3478
|
+
declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3646
3479
|
/**
|
|
3647
3480
|
* Updates the Catalog plugin options on a data collection.
|
|
3648
3481
|
*
|
|
@@ -3658,7 +3491,7 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3658
3491
|
* @applicableIdentity APP
|
|
3659
3492
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCatalogPlugin
|
|
3660
3493
|
*/
|
|
3661
|
-
declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3494
|
+
declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3662
3495
|
interface UpdateCatalogPluginOptions {
|
|
3663
3496
|
/** Replacement options for the Catalog plugin. Omitted options use their defaults. */
|
|
3664
3497
|
catalogOptions: CatalogOptions;
|
|
@@ -3678,7 +3511,7 @@ interface UpdateCatalogPluginOptions {
|
|
|
3678
3511
|
* @applicableIdentity APP
|
|
3679
3512
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDraftItemsPlugin
|
|
3680
3513
|
*/
|
|
3681
|
-
declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNullablePaths<AddDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<AddDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3514
|
+
declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNullablePaths<AddDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<AddDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3682
3515
|
interface AddDraftItemsPluginOptions {
|
|
3683
3516
|
/** Draft Items plugin options. */
|
|
3684
3517
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
@@ -3702,7 +3535,7 @@ interface AddDraftItemsPluginOptions {
|
|
|
3702
3535
|
* @applicableIdentity APP
|
|
3703
3536
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDraftItemsPlugin
|
|
3704
3537
|
*/
|
|
3705
|
-
declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3538
|
+
declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3706
3539
|
interface DeleteDraftItemsPluginOptions {
|
|
3707
3540
|
/**
|
|
3708
3541
|
* Action to take for existing draft items.
|
|
@@ -3726,7 +3559,7 @@ interface DeleteDraftItemsPluginOptions {
|
|
|
3726
3559
|
* @applicableIdentity APP
|
|
3727
3560
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDraftItemsPlugin
|
|
3728
3561
|
*/
|
|
3729
|
-
declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3562
|
+
declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3730
3563
|
interface UpdateDraftItemsPluginOptions {
|
|
3731
3564
|
/**
|
|
3732
3565
|
* Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
|
|
@@ -3749,6 +3582,6 @@ interface UpdateDraftItemsPluginOptions {
|
|
|
3749
3582
|
* @applicableIdentity APP
|
|
3750
3583
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollectionField
|
|
3751
3584
|
*/
|
|
3752
|
-
declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3585
|
+
declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.typeMetadata.pageLink.pageLinkType` | `dataCollection.fields.${number}.typeMetadata.slug.pattern` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3753
3586
|
|
|
3754
3587
|
export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddCatalogPluginOptions, type AddCatalogPluginRequest, type AddCatalogPluginResponse, type AddCmsPluginOptions, type AddCmsPluginRequest, type AddCmsPluginResponse, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type AddDraftItemsPluginOptions, type AddDraftItemsPluginRequest, type AddDraftItemsPluginResponse, type AddMultilingualPluginOptions, type AddMultilingualPluginRequest, type AddMultilingualPluginResponse, type AddPublishPluginOptions, type AddPublishPluginRequest, type AddPublishPluginResponse, type AddUrlizedPluginOptions, type AddUrlizedPluginRequest, type AddUrlizedPluginResponse, type Address, type AllowedDataPermissions, type AllowedDraftPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsOptions, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteCatalogPluginRequest, type DeleteCatalogPluginResponse, type DeleteCmsPluginRequest, type DeleteCmsPluginResponse, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type DeleteDraftItemsPluginOptions, type DeleteDraftItemsPluginRequest, type DeleteDraftItemsPluginResponse, type DeleteMultilingualPluginRequest, type DeleteMultilingualPluginResponse, type DeletePublishPluginRequest, type DeletePublishPluginResponse, type DeleteUrlizedPluginRequest, type DeleteUrlizedPluginResponse, type Deprecation, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, DraftItemsPluginConflictAction, type DraftItemsPluginConflictActionWithLiterals, type DraftItemsPluginOptions, type DraftItemsPluginOptionsPairedCollectionOneOf, DraftItemsRemovalAction, type DraftItemsRemovalActionWithLiterals, type DraftPermissions, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, LifecycleStatus, type LifecycleStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MediaImage, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type PermissionsUpdate, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, PublishPluginConflictAction, type PublishPluginConflictActionWithLiterals, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StrictModeUpdate, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateCatalogPluginOptions, type UpdateCatalogPluginRequest, type UpdateCatalogPluginResponse, type UpdateCmsPluginOptions, type UpdateCmsPluginRequest, type UpdateCmsPluginResponse, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UpdateDraftItemsPluginOptions, type UpdateDraftItemsPluginRequest, type UpdateDraftItemsPluginResponse, type UpdateMultilingualPluginOptions, type UpdateMultilingualPluginRequest, type UpdateMultilingualPluginResponse, type UpdatePublishPluginOptions, type UpdatePublishPluginRequest, type UpdatePublishPluginResponse, type UpdateUrlizedPluginOptions, type UpdateUrlizedPluginRequest, type UpdateUrlizedPluginResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addCatalogPlugin, addCmsPlugin, addDataCollectionPlugin, addDraftItemsPlugin, addMultilingualPlugin, addPublishPlugin, addUrlizedPlugin, bulkGetDataCollections, createDataCollection, createDataCollectionField, deleteCatalogPlugin, deleteCmsPlugin, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, deleteDraftItemsPlugin, deleteMultilingualPlugin, deletePublishPlugin, deleteUrlizedPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, restoreDataCollection, updateCatalogPlugin, updateCmsPlugin, updateDataCollection, updateDataCollectionField, updateDraftItemsPlugin, updateMultilingualPlugin, updatePublishPlugin, updateUrlizedPlugin };
|