@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
|
@@ -96,6 +96,11 @@ interface DataCollection {
|
|
|
96
96
|
* @readonly
|
|
97
97
|
*/
|
|
98
98
|
_updatedDate?: Date | null;
|
|
99
|
+
/**
|
|
100
|
+
* Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
|
|
101
|
+
* @readonly
|
|
102
|
+
*/
|
|
103
|
+
allowedDataPermissions?: AllowedDataPermissions;
|
|
99
104
|
/**
|
|
100
105
|
* Deprecation metadata for this collection. App collections set this metadata to direct users to a replacement collection.
|
|
101
106
|
* @readonly
|
|
@@ -377,6 +382,11 @@ declare enum Type {
|
|
|
377
382
|
* @documentationMaturity preview
|
|
378
383
|
*/
|
|
379
384
|
EMAIL = "EMAIL",
|
|
385
|
+
/**
|
|
386
|
+
* Secured media object with digital file metadata.
|
|
387
|
+
* @documentationMaturity preview
|
|
388
|
+
*/
|
|
389
|
+
SECURED_MEDIA = "SECURED_MEDIA",
|
|
380
390
|
/**
|
|
381
391
|
* Media image object.
|
|
382
392
|
* @documentationMaturity preview
|
|
@@ -389,7 +399,7 @@ declare enum Type {
|
|
|
389
399
|
MEDIA_VECTOR_ART = "MEDIA_VECTOR_ART"
|
|
390
400
|
}
|
|
391
401
|
/** @enumType */
|
|
392
|
-
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';
|
|
402
|
+
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';
|
|
393
403
|
interface TypeMetadata extends TypeMetadataMetadataOneOf {
|
|
394
404
|
/** Metadata for a reference field. */
|
|
395
405
|
reference?: Reference;
|
|
@@ -401,6 +411,48 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
|
|
|
401
411
|
array?: _Array;
|
|
402
412
|
/** Metadata for a page link field. */
|
|
403
413
|
pageLink?: PageLink;
|
|
414
|
+
/** Metadata for a slug field. */
|
|
415
|
+
slug?: Slug;
|
|
416
|
+
/** Metadata for TEXT. */
|
|
417
|
+
text?: Text;
|
|
418
|
+
/** Metadata for NUMBER. */
|
|
419
|
+
number?: _Number;
|
|
420
|
+
/** Metadata for DATE. */
|
|
421
|
+
date?: _Date;
|
|
422
|
+
/** Metadata for DATETIME. */
|
|
423
|
+
datetime?: Datetime;
|
|
424
|
+
/** Metadata for IMAGE. */
|
|
425
|
+
image?: Image;
|
|
426
|
+
/** Metadata for BOOLEAN. */
|
|
427
|
+
boolean?: _Boolean;
|
|
428
|
+
/** Metadata for DOCUMENT. */
|
|
429
|
+
document?: Document;
|
|
430
|
+
/** Metadata for URL. */
|
|
431
|
+
url?: Url;
|
|
432
|
+
/** Metadata for RICH_TEXT. */
|
|
433
|
+
richText?: RichText;
|
|
434
|
+
/** Metadata for VIDEO. */
|
|
435
|
+
video?: Video;
|
|
436
|
+
/** Metadata for ARRAY_STRING. */
|
|
437
|
+
arrayString?: ArrayString;
|
|
438
|
+
/** Metadata for ARRAY_DOCUMENT. */
|
|
439
|
+
arrayDocument?: ArrayDocument;
|
|
440
|
+
/** Metadata for AUDIO. */
|
|
441
|
+
audio?: Audio;
|
|
442
|
+
/** Metadata for TIME. */
|
|
443
|
+
time?: Time;
|
|
444
|
+
/** Metadata for RICH_CONTENT. */
|
|
445
|
+
richContent?: RichContent;
|
|
446
|
+
/** Metadata for MEDIA_GALLERY. */
|
|
447
|
+
mediaGallery?: MediaGallery;
|
|
448
|
+
/** Metadata for ADDRESS. */
|
|
449
|
+
address?: Address;
|
|
450
|
+
/** Metadata for EMAIL. */
|
|
451
|
+
email?: Email;
|
|
452
|
+
/** Metadata for LEGACY_COLOR. */
|
|
453
|
+
legacyColor?: LegacyColor;
|
|
454
|
+
/** Metadata for MEDIA_IMAGE. */
|
|
455
|
+
mediaImage?: MediaImage;
|
|
404
456
|
}
|
|
405
457
|
/** @oneof */
|
|
406
458
|
interface TypeMetadataMetadataOneOf {
|
|
@@ -414,6 +466,48 @@ interface TypeMetadataMetadataOneOf {
|
|
|
414
466
|
array?: _Array;
|
|
415
467
|
/** Metadata for a page link field. */
|
|
416
468
|
pageLink?: PageLink;
|
|
469
|
+
/** Metadata for a slug field. */
|
|
470
|
+
slug?: Slug;
|
|
471
|
+
/** Metadata for TEXT. */
|
|
472
|
+
text?: Text;
|
|
473
|
+
/** Metadata for NUMBER. */
|
|
474
|
+
number?: _Number;
|
|
475
|
+
/** Metadata for DATE. */
|
|
476
|
+
date?: _Date;
|
|
477
|
+
/** Metadata for DATETIME. */
|
|
478
|
+
datetime?: Datetime;
|
|
479
|
+
/** Metadata for IMAGE. */
|
|
480
|
+
image?: Image;
|
|
481
|
+
/** Metadata for BOOLEAN. */
|
|
482
|
+
boolean?: _Boolean;
|
|
483
|
+
/** Metadata for DOCUMENT. */
|
|
484
|
+
document?: Document;
|
|
485
|
+
/** Metadata for URL. */
|
|
486
|
+
url?: Url;
|
|
487
|
+
/** Metadata for RICH_TEXT. */
|
|
488
|
+
richText?: RichText;
|
|
489
|
+
/** Metadata for VIDEO. */
|
|
490
|
+
video?: Video;
|
|
491
|
+
/** Metadata for ARRAY_STRING. */
|
|
492
|
+
arrayString?: ArrayString;
|
|
493
|
+
/** Metadata for ARRAY_DOCUMENT. */
|
|
494
|
+
arrayDocument?: ArrayDocument;
|
|
495
|
+
/** Metadata for AUDIO. */
|
|
496
|
+
audio?: Audio;
|
|
497
|
+
/** Metadata for TIME. */
|
|
498
|
+
time?: Time;
|
|
499
|
+
/** Metadata for RICH_CONTENT. */
|
|
500
|
+
richContent?: RichContent;
|
|
501
|
+
/** Metadata for MEDIA_GALLERY. */
|
|
502
|
+
mediaGallery?: MediaGallery;
|
|
503
|
+
/** Metadata for ADDRESS. */
|
|
504
|
+
address?: Address;
|
|
505
|
+
/** Metadata for EMAIL. */
|
|
506
|
+
email?: Email;
|
|
507
|
+
/** Metadata for LEGACY_COLOR. */
|
|
508
|
+
legacyColor?: LegacyColor;
|
|
509
|
+
/** Metadata for MEDIA_IMAGE. */
|
|
510
|
+
mediaImage?: MediaImage;
|
|
417
511
|
}
|
|
418
512
|
interface FieldCapabilities {
|
|
419
513
|
/**
|
|
@@ -548,12 +642,19 @@ interface _Object {
|
|
|
548
642
|
* @maxSize 1000
|
|
549
643
|
*/
|
|
550
644
|
fields?: ObjectField[];
|
|
645
|
+
/** Value assigned when a data item omits this field. */
|
|
646
|
+
defaultValue?: Record<string, any> | null;
|
|
551
647
|
}
|
|
552
648
|
interface _Array {
|
|
553
649
|
/** Element's data type. */
|
|
554
650
|
elementType?: TypeWithLiterals;
|
|
555
651
|
/** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
|
|
556
652
|
typeMetadata?: TypeMetadata;
|
|
653
|
+
/** Minimum permitted number of items in an array field. */
|
|
654
|
+
minSize?: number | null;
|
|
655
|
+
/** Maximum permitted number of items in an array field. */
|
|
656
|
+
maxSize?: number | null;
|
|
657
|
+
defaultValue?: any[];
|
|
557
658
|
}
|
|
558
659
|
interface PageLink {
|
|
559
660
|
/** Calculation pattern used to generate the page link. Required for page link fields. */
|
|
@@ -563,6 +664,8 @@ interface PageLink {
|
|
|
563
664
|
* @maxLength 1000
|
|
564
665
|
*/
|
|
565
666
|
linkedRouterPage?: string | null;
|
|
667
|
+
/** Defines the type of the page link. */
|
|
668
|
+
pageLinkType?: PageLinkTypeWithLiterals;
|
|
566
669
|
}
|
|
567
670
|
interface Slug {
|
|
568
671
|
/**
|
|
@@ -571,6 +674,11 @@ interface Slug {
|
|
|
571
674
|
* @maxLength 1000
|
|
572
675
|
*/
|
|
573
676
|
pattern?: string;
|
|
677
|
+
/** Minimum permitted length for a string field. */
|
|
678
|
+
minLength?: number | null;
|
|
679
|
+
/** Maximum permitted length for a string field. */
|
|
680
|
+
maxLength?: number | null;
|
|
681
|
+
defaultValue?: string | null;
|
|
574
682
|
}
|
|
575
683
|
interface Text extends TextValidationOneOf {
|
|
576
684
|
/** Length and pattern constraints for the text value. */
|
|
@@ -1456,6 +1564,8 @@ interface GetDataCollectionRequest {
|
|
|
1456
1564
|
* Default: `false`
|
|
1457
1565
|
*/
|
|
1458
1566
|
consistentRead?: boolean;
|
|
1567
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1568
|
+
includeAllowedDataPermissions?: boolean;
|
|
1459
1569
|
/**
|
|
1460
1570
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1461
1571
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -1499,6 +1609,8 @@ interface ListDataCollectionsRequest {
|
|
|
1499
1609
|
* Default: `false`
|
|
1500
1610
|
*/
|
|
1501
1611
|
consistentRead?: boolean;
|
|
1612
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1613
|
+
includeAllowedDataPermissions?: boolean;
|
|
1502
1614
|
/**
|
|
1503
1615
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1504
1616
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -1581,6 +1693,8 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1581
1693
|
* Default: `false`
|
|
1582
1694
|
*/
|
|
1583
1695
|
consistentRead?: boolean;
|
|
1696
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1697
|
+
includeAllowedDataPermissions?: boolean;
|
|
1584
1698
|
/**
|
|
1585
1699
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1586
1700
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2527,7 +2641,7 @@ interface AccountInfo {
|
|
|
2527
2641
|
* @returns Created collection.
|
|
2528
2642
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
|
|
2529
2643
|
*/
|
|
2530
|
-
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>>;
|
|
2644
|
+
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>>;
|
|
2531
2645
|
/**
|
|
2532
2646
|
* Retrieves a data collection by ID.
|
|
2533
2647
|
*
|
|
@@ -2546,7 +2660,7 @@ declare function createDataCollection(collection: NonNullablePaths<DataCollectio
|
|
|
2546
2660
|
* @returns Requested collection.
|
|
2547
2661
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
|
|
2548
2662
|
*/
|
|
2549
|
-
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>>;
|
|
2663
|
+
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>>;
|
|
2550
2664
|
interface GetDataCollectionOptions {
|
|
2551
2665
|
/**
|
|
2552
2666
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -2556,6 +2670,8 @@ interface GetDataCollectionOptions {
|
|
|
2556
2670
|
* Default: `false`
|
|
2557
2671
|
*/
|
|
2558
2672
|
consistentRead?: boolean;
|
|
2673
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2674
|
+
includeAllowedDataPermissions?: boolean;
|
|
2559
2675
|
/**
|
|
2560
2676
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2561
2677
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2577,7 +2693,7 @@ interface GetDataCollectionOptions {
|
|
|
2577
2693
|
* @applicableIdentity APP
|
|
2578
2694
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.ListDataCollections
|
|
2579
2695
|
*/
|
|
2580
|
-
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>>;
|
|
2696
|
+
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>>;
|
|
2581
2697
|
interface ListDataCollectionsOptions {
|
|
2582
2698
|
/**
|
|
2583
2699
|
* Defines how collections in the response are sorted.
|
|
@@ -2601,6 +2717,8 @@ interface ListDataCollectionsOptions {
|
|
|
2601
2717
|
* Default: `false`
|
|
2602
2718
|
*/
|
|
2603
2719
|
consistentRead?: boolean;
|
|
2720
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2721
|
+
includeAllowedDataPermissions?: boolean;
|
|
2604
2722
|
/**
|
|
2605
2723
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2606
2724
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2629,7 +2747,7 @@ interface ListDataCollectionsOptions {
|
|
|
2629
2747
|
* @applicableIdentity APP
|
|
2630
2748
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.BulkGetDataCollections
|
|
2631
2749
|
*/
|
|
2632
|
-
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>>;
|
|
2750
|
+
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>>;
|
|
2633
2751
|
interface BulkGetDataCollectionsOptions {
|
|
2634
2752
|
/**
|
|
2635
2753
|
* IDs of the collections to retrieve.
|
|
@@ -2666,6 +2784,8 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2666
2784
|
* Default: `false`
|
|
2667
2785
|
*/
|
|
2668
2786
|
consistentRead?: boolean;
|
|
2787
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2788
|
+
includeAllowedDataPermissions?: boolean;
|
|
2669
2789
|
/**
|
|
2670
2790
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2671
2791
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2713,7 +2833,7 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2713
2833
|
* @returns Updated collection details.
|
|
2714
2834
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollection
|
|
2715
2835
|
*/
|
|
2716
|
-
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>>;
|
|
2836
|
+
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>>;
|
|
2717
2837
|
/**
|
|
2718
2838
|
* Deletes a data collection.
|
|
2719
2839
|
*
|
|
@@ -2744,7 +2864,7 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
|
|
|
2744
2864
|
* @applicableIdentity APP
|
|
2745
2865
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection
|
|
2746
2866
|
*/
|
|
2747
|
-
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>>;
|
|
2867
|
+
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>>;
|
|
2748
2868
|
/**
|
|
2749
2869
|
* Updates specified properties of a data collection.
|
|
2750
2870
|
*
|
|
@@ -2763,7 +2883,7 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
|
|
|
2763
2883
|
* @applicableIdentity APP
|
|
2764
2884
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
|
|
2765
2885
|
*/
|
|
2766
|
-
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>>;
|
|
2886
|
+
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>>;
|
|
2767
2887
|
interface PatchDataCollection {
|
|
2768
2888
|
/**
|
|
2769
2889
|
* [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`.
|
|
@@ -2856,6 +2976,11 @@ interface PatchDataCollection {
|
|
|
2856
2976
|
* @readonly
|
|
2857
2977
|
*/
|
|
2858
2978
|
_updatedDate?: Date | null;
|
|
2979
|
+
/**
|
|
2980
|
+
* Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
|
|
2981
|
+
* @readonly
|
|
2982
|
+
*/
|
|
2983
|
+
allowedDataPermissions?: AllowedDataPermissions;
|
|
2859
2984
|
/**
|
|
2860
2985
|
* Deprecation metadata for this collection. App collections set this metadata to direct users to a replacement collection.
|
|
2861
2986
|
* @readonly
|
|
@@ -2875,7 +3000,7 @@ interface PatchDataCollection {
|
|
|
2875
3000
|
* @applicableIdentity APP
|
|
2876
3001
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollectionField
|
|
2877
3002
|
*/
|
|
2878
|
-
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>>;
|
|
3003
|
+
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>>;
|
|
2879
3004
|
interface CreateDataCollectionFieldOptions {
|
|
2880
3005
|
/** New field to add. */
|
|
2881
3006
|
field: Field;
|
|
@@ -2902,7 +3027,7 @@ interface CreateDataCollectionFieldOptions {
|
|
|
2902
3027
|
* @applicableIdentity APP
|
|
2903
3028
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollectionField
|
|
2904
3029
|
*/
|
|
2905
|
-
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>>;
|
|
3030
|
+
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>>;
|
|
2906
3031
|
interface UpdateDataCollectionFieldOptions {
|
|
2907
3032
|
/** Field to update. */
|
|
2908
3033
|
field: Field;
|
|
@@ -2921,7 +3046,7 @@ interface UpdateDataCollectionFieldOptions {
|
|
|
2921
3046
|
* @applicableIdentity APP
|
|
2922
3047
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionField
|
|
2923
3048
|
*/
|
|
2924
|
-
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>>;
|
|
3049
|
+
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>>;
|
|
2925
3050
|
interface DeleteDataCollectionFieldOptions {
|
|
2926
3051
|
/**
|
|
2927
3052
|
* ID of the field to delete.
|
|
@@ -2943,7 +3068,7 @@ interface DeleteDataCollectionFieldOptions {
|
|
|
2943
3068
|
* @applicableIdentity APP
|
|
2944
3069
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDataCollectionPlugin
|
|
2945
3070
|
*/
|
|
2946
|
-
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>>;
|
|
3071
|
+
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>>;
|
|
2947
3072
|
interface AddDataCollectionPluginOptions {
|
|
2948
3073
|
/**
|
|
2949
3074
|
* Plugin to add to the collection. Must include the plugin type and any type-specific configuration.
|
|
@@ -2964,7 +3089,7 @@ interface AddDataCollectionPluginOptions {
|
|
|
2964
3089
|
* @applicableIdentity APP
|
|
2965
3090
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionPlugin
|
|
2966
3091
|
*/
|
|
2967
|
-
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>>;
|
|
3092
|
+
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>>;
|
|
2968
3093
|
interface DeleteDataCollectionPluginOptions {
|
|
2969
3094
|
/** Plugin type to remove. */
|
|
2970
3095
|
pluginType: PluginTypeWithLiterals;
|
|
@@ -2984,7 +3109,7 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2984
3109
|
* @applicableIdentity APP
|
|
2985
3110
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddPublishPlugin
|
|
2986
3111
|
*/
|
|
2987
|
-
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>>;
|
|
3112
|
+
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>>;
|
|
2988
3113
|
interface AddPublishPluginOptions {
|
|
2989
3114
|
/** Publish plugin options. */
|
|
2990
3115
|
publishOptions: PublishPluginOptions;
|
|
@@ -3007,7 +3132,7 @@ interface AddPublishPluginOptions {
|
|
|
3007
3132
|
* @applicableIdentity APP
|
|
3008
3133
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeletePublishPlugin
|
|
3009
3134
|
*/
|
|
3010
|
-
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>>;
|
|
3135
|
+
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>>;
|
|
3011
3136
|
/**
|
|
3012
3137
|
* Updates the Publish plugin options on a data collection.
|
|
3013
3138
|
*
|
|
@@ -3023,7 +3148,7 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3023
3148
|
* @applicableIdentity APP
|
|
3024
3149
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdatePublishPlugin
|
|
3025
3150
|
*/
|
|
3026
|
-
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>>;
|
|
3151
|
+
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>>;
|
|
3027
3152
|
interface UpdatePublishPluginOptions {
|
|
3028
3153
|
/**
|
|
3029
3154
|
* Replacement writable options for the Publish plugin. Omitted options use their defaults.
|
|
@@ -3046,7 +3171,7 @@ interface UpdatePublishPluginOptions {
|
|
|
3046
3171
|
* @applicableIdentity APP
|
|
3047
3172
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddUrlizedPlugin
|
|
3048
3173
|
*/
|
|
3049
|
-
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>>;
|
|
3174
|
+
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>>;
|
|
3050
3175
|
interface AddUrlizedPluginOptions {
|
|
3051
3176
|
/** Urlized plugin options. */
|
|
3052
3177
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3063,7 +3188,7 @@ interface AddUrlizedPluginOptions {
|
|
|
3063
3188
|
* @applicableIdentity APP
|
|
3064
3189
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteUrlizedPlugin
|
|
3065
3190
|
*/
|
|
3066
|
-
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>>;
|
|
3191
|
+
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>>;
|
|
3067
3192
|
/**
|
|
3068
3193
|
* Updates the Urlized plugin options on a data collection.
|
|
3069
3194
|
*
|
|
@@ -3079,7 +3204,7 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3079
3204
|
* @applicableIdentity APP
|
|
3080
3205
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateUrlizedPlugin
|
|
3081
3206
|
*/
|
|
3082
|
-
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>>;
|
|
3207
|
+
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>>;
|
|
3083
3208
|
interface UpdateUrlizedPluginOptions {
|
|
3084
3209
|
/** Replacement options for the Urlized plugin. Omitted options use their defaults. */
|
|
3085
3210
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3099,7 +3224,7 @@ interface UpdateUrlizedPluginOptions {
|
|
|
3099
3224
|
* @applicableIdentity APP
|
|
3100
3225
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddMultilingualPlugin
|
|
3101
3226
|
*/
|
|
3102
|
-
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>>;
|
|
3227
|
+
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>>;
|
|
3103
3228
|
interface AddMultilingualPluginOptions {
|
|
3104
3229
|
/** Multilingual plugin options. */
|
|
3105
3230
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3116,7 +3241,7 @@ interface AddMultilingualPluginOptions {
|
|
|
3116
3241
|
* @applicableIdentity APP
|
|
3117
3242
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteMultilingualPlugin
|
|
3118
3243
|
*/
|
|
3119
|
-
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>>;
|
|
3244
|
+
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>>;
|
|
3120
3245
|
/**
|
|
3121
3246
|
* Updates the Multilingual plugin options on a data collection.
|
|
3122
3247
|
*
|
|
@@ -3132,7 +3257,7 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
|
|
|
3132
3257
|
* @applicableIdentity APP
|
|
3133
3258
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateMultilingualPlugin
|
|
3134
3259
|
*/
|
|
3135
|
-
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>>;
|
|
3260
|
+
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>>;
|
|
3136
3261
|
interface UpdateMultilingualPluginOptions {
|
|
3137
3262
|
/** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
|
|
3138
3263
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3152,7 +3277,7 @@ interface UpdateMultilingualPluginOptions {
|
|
|
3152
3277
|
* @applicableIdentity APP
|
|
3153
3278
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCmsPlugin
|
|
3154
3279
|
*/
|
|
3155
|
-
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>>;
|
|
3280
|
+
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>>;
|
|
3156
3281
|
interface AddCmsPluginOptions {
|
|
3157
3282
|
/** CMS plugin options. */
|
|
3158
3283
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3169,7 +3294,7 @@ interface AddCmsPluginOptions {
|
|
|
3169
3294
|
* @applicableIdentity APP
|
|
3170
3295
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCmsPlugin
|
|
3171
3296
|
*/
|
|
3172
|
-
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>>;
|
|
3297
|
+
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>>;
|
|
3173
3298
|
/**
|
|
3174
3299
|
* Updates the CMS plugin options on a data collection.
|
|
3175
3300
|
*
|
|
@@ -3185,7 +3310,7 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
|
|
|
3185
3310
|
* @applicableIdentity APP
|
|
3186
3311
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCmsPlugin
|
|
3187
3312
|
*/
|
|
3188
|
-
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>>;
|
|
3313
|
+
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>>;
|
|
3189
3314
|
interface UpdateCmsPluginOptions {
|
|
3190
3315
|
/** Replacement options for the CMS plugin. Omitted options use their defaults. */
|
|
3191
3316
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3205,7 +3330,7 @@ interface UpdateCmsPluginOptions {
|
|
|
3205
3330
|
* @applicableIdentity APP
|
|
3206
3331
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCatalogPlugin
|
|
3207
3332
|
*/
|
|
3208
|
-
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>>;
|
|
3333
|
+
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>>;
|
|
3209
3334
|
interface AddCatalogPluginOptions {
|
|
3210
3335
|
/** Catalog plugin options. */
|
|
3211
3336
|
catalogOptions: CatalogOptions;
|
|
@@ -3222,7 +3347,7 @@ interface AddCatalogPluginOptions {
|
|
|
3222
3347
|
* @applicableIdentity APP
|
|
3223
3348
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCatalogPlugin
|
|
3224
3349
|
*/
|
|
3225
|
-
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>>;
|
|
3350
|
+
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>>;
|
|
3226
3351
|
/**
|
|
3227
3352
|
* Updates the Catalog plugin options on a data collection.
|
|
3228
3353
|
*
|
|
@@ -3238,7 +3363,7 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3238
3363
|
* @applicableIdentity APP
|
|
3239
3364
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCatalogPlugin
|
|
3240
3365
|
*/
|
|
3241
|
-
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>>;
|
|
3366
|
+
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>>;
|
|
3242
3367
|
interface UpdateCatalogPluginOptions {
|
|
3243
3368
|
/** Replacement options for the Catalog plugin. Omitted options use their defaults. */
|
|
3244
3369
|
catalogOptions: CatalogOptions;
|
|
@@ -3258,7 +3383,7 @@ interface UpdateCatalogPluginOptions {
|
|
|
3258
3383
|
* @applicableIdentity APP
|
|
3259
3384
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDraftItemsPlugin
|
|
3260
3385
|
*/
|
|
3261
|
-
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>>;
|
|
3386
|
+
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>>;
|
|
3262
3387
|
interface AddDraftItemsPluginOptions {
|
|
3263
3388
|
/** Draft Items plugin options. */
|
|
3264
3389
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
@@ -3282,7 +3407,7 @@ interface AddDraftItemsPluginOptions {
|
|
|
3282
3407
|
* @applicableIdentity APP
|
|
3283
3408
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDraftItemsPlugin
|
|
3284
3409
|
*/
|
|
3285
|
-
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>>;
|
|
3410
|
+
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>>;
|
|
3286
3411
|
interface DeleteDraftItemsPluginOptions {
|
|
3287
3412
|
/**
|
|
3288
3413
|
* Action to take for existing draft items.
|
|
@@ -3306,7 +3431,7 @@ interface DeleteDraftItemsPluginOptions {
|
|
|
3306
3431
|
* @applicableIdentity APP
|
|
3307
3432
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDraftItemsPlugin
|
|
3308
3433
|
*/
|
|
3309
|
-
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>>;
|
|
3434
|
+
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>>;
|
|
3310
3435
|
interface UpdateDraftItemsPluginOptions {
|
|
3311
3436
|
/**
|
|
3312
3437
|
* Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
|
|
@@ -3329,6 +3454,6 @@ interface UpdateDraftItemsPluginOptions {
|
|
|
3329
3454
|
* @applicableIdentity APP
|
|
3330
3455
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollectionField
|
|
3331
3456
|
*/
|
|
3332
|
-
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>>;
|
|
3457
|
+
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>>;
|
|
3333
3458
|
|
|
3334
3459
|
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 };
|