@wix/auto_sdk_data_collections 1.0.111 → 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 +16 -16
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +211 -36
- package/build/cjs/index.typings.js +16 -16
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +169 -5
- package/build/cjs/meta.js +16 -16
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +31 -31
- package/build/es/index.mjs +16 -16
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +211 -36
- package/build/es/index.typings.mjs +16 -16
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +169 -5
- package/build/es/meta.mjs +16 -16
- 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 +99 -310
- package/build/internal/cjs/meta.d.ts +65 -266
- package/build/internal/es/index.d.mts +31 -31
- package/build/internal/es/index.typings.d.mts +99 -310
- package/build/internal/es/meta.d.mts +65 -266
- 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. */
|
|
@@ -820,10 +928,16 @@ declare enum FieldPluginType {
|
|
|
820
928
|
/** Unknown plugin type. */
|
|
821
929
|
UNKNOWN = "UNKNOWN",
|
|
822
930
|
/** CMS-related field attributes. */
|
|
823
|
-
CMS = "CMS"
|
|
931
|
+
CMS = "CMS",
|
|
932
|
+
/** Marks a multi-reference field as a category field linking to a Category Group. */
|
|
933
|
+
CATEGORY_FIELD = "CATEGORY_FIELD",
|
|
934
|
+
/** Marks a back-reference field on Category Groups indicating a consumer relationship. */
|
|
935
|
+
CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
|
|
936
|
+
/** Marks the auto-managed primary category single-reference field on a consumer collection. */
|
|
937
|
+
PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
|
|
824
938
|
}
|
|
825
939
|
/** @enumType */
|
|
826
|
-
type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
|
|
940
|
+
type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS' | 'CATEGORY_FIELD' | 'CATEGORY_CONSUMER' | 'PRIMARY_CATEGORY_FIELD';
|
|
827
941
|
/** Options for the CMS plugin. */
|
|
828
942
|
interface CmsOptions {
|
|
829
943
|
/**
|
|
@@ -917,6 +1031,10 @@ interface Plugin extends PluginOptionsOneOf {
|
|
|
917
1031
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
918
1032
|
/** Options for the CMS plugin. */
|
|
919
1033
|
cmsOptions?: PluginCmsOptions;
|
|
1034
|
+
/** Options for the Catalog plugin. */
|
|
1035
|
+
catalogOptions?: CatalogOptions;
|
|
1036
|
+
/** Options for the Draft Items plugin. */
|
|
1037
|
+
draftItemsOptions?: DraftItemsPluginOptions;
|
|
920
1038
|
/** Plugin type. */
|
|
921
1039
|
type?: PluginTypeWithLiterals;
|
|
922
1040
|
}
|
|
@@ -937,6 +1055,10 @@ interface PluginOptionsOneOf {
|
|
|
937
1055
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
938
1056
|
/** Options for the CMS plugin. */
|
|
939
1057
|
cmsOptions?: PluginCmsOptions;
|
|
1058
|
+
/** Options for the Catalog plugin. */
|
|
1059
|
+
catalogOptions?: CatalogOptions;
|
|
1060
|
+
/** Options for the Draft Items plugin. */
|
|
1061
|
+
draftItemsOptions?: DraftItemsPluginOptions;
|
|
940
1062
|
}
|
|
941
1063
|
declare enum Status {
|
|
942
1064
|
/** Items are published by default. */
|
|
@@ -987,6 +1109,23 @@ declare enum AccessLevel {
|
|
|
987
1109
|
/** @enumType */
|
|
988
1110
|
type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
|
|
989
1111
|
interface DraftPermissions {
|
|
1112
|
+
/**
|
|
1113
|
+
* Access level required to view/edit/remove items from the drafts collection.
|
|
1114
|
+
* Can be set to one of CMS_EDITOR, PRIVILEGED
|
|
1115
|
+
* Default: `CMS_EDITOR`
|
|
1116
|
+
*/
|
|
1117
|
+
manageDrafts?: AccessLevelWithLiterals;
|
|
1118
|
+
/**
|
|
1119
|
+
* Access level required to publish draft items and unpublish published items.
|
|
1120
|
+
* Can be set to one of CMS_EDITOR, PRIVILEGED
|
|
1121
|
+
* Default: `CMS_EDITOR`
|
|
1122
|
+
*/
|
|
1123
|
+
managePublishStatus?: AccessLevelWithLiterals;
|
|
1124
|
+
/**
|
|
1125
|
+
* Access level required to view draft items. Managing drafts also grants viewing.
|
|
1126
|
+
* If omitted, inherits manage_drafts for compatibility.
|
|
1127
|
+
*/
|
|
1128
|
+
viewDrafts?: AccessLevelWithLiterals;
|
|
990
1129
|
}
|
|
991
1130
|
interface AllowedDraftPermissions {
|
|
992
1131
|
/** If manage_drafts is permitted for the caller. */
|
|
@@ -1012,10 +1151,16 @@ declare enum PluginType {
|
|
|
1012
1151
|
/** Indicates that page link fields are persisted and can be updated. */
|
|
1013
1152
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1014
1153
|
/** CMS-specific collection properties. */
|
|
1015
|
-
CMS = "CMS"
|
|
1154
|
+
CMS = "CMS",
|
|
1155
|
+
/** Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog. */
|
|
1156
|
+
CATALOG = "CATALOG",
|
|
1157
|
+
/** Marks the collection as a Category Group for categorization features. */
|
|
1158
|
+
CATEGORIES = "CATEGORIES",
|
|
1159
|
+
/** Enables the draft items collection: safe draft editing with explicit publish step. */
|
|
1160
|
+
DRAFT_ITEMS = "DRAFT_ITEMS"
|
|
1016
1161
|
}
|
|
1017
1162
|
/** @enumType */
|
|
1018
|
-
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
|
|
1163
|
+
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS' | 'CATALOG' | 'CATEGORIES' | 'DRAFT_ITEMS';
|
|
1019
1164
|
interface PublishPluginOptions {
|
|
1020
1165
|
/**
|
|
1021
1166
|
* Publication status assigned to items that don't specify one.
|
|
@@ -1234,6 +1379,19 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
|
|
|
1234
1379
|
* @readonly
|
|
1235
1380
|
*/
|
|
1236
1381
|
publishedCollectionId?: string;
|
|
1382
|
+
/** Access levels required to view and manage drafts and change publication status. */
|
|
1383
|
+
draftPermissions?: DraftPermissions;
|
|
1384
|
+
/**
|
|
1385
|
+
* Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
|
|
1386
|
+
* @readonly
|
|
1387
|
+
*/
|
|
1388
|
+
allowedPermissions?: AllowedDraftPermissions;
|
|
1389
|
+
/**
|
|
1390
|
+
* Whether writes to the published collection are allowed while the Draft Items plugin is enabled.
|
|
1391
|
+
* Defaults to `false` for newly created collections and newly added plugins.
|
|
1392
|
+
* Existing schemas that predate this field return `true` for backwards compatibility.
|
|
1393
|
+
*/
|
|
1394
|
+
allowWritesToPublishedCollection?: boolean;
|
|
1237
1395
|
}
|
|
1238
1396
|
/** @oneof */
|
|
1239
1397
|
interface DraftItemsPluginOptionsPairedCollectionOneOf {
|
|
@@ -1406,6 +1564,8 @@ interface GetDataCollectionRequest {
|
|
|
1406
1564
|
* Default: `false`
|
|
1407
1565
|
*/
|
|
1408
1566
|
consistentRead?: boolean;
|
|
1567
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1568
|
+
includeAllowedDataPermissions?: boolean;
|
|
1409
1569
|
/**
|
|
1410
1570
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1411
1571
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -1449,6 +1609,8 @@ interface ListDataCollectionsRequest {
|
|
|
1449
1609
|
* Default: `false`
|
|
1450
1610
|
*/
|
|
1451
1611
|
consistentRead?: boolean;
|
|
1612
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1613
|
+
includeAllowedDataPermissions?: boolean;
|
|
1452
1614
|
/**
|
|
1453
1615
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1454
1616
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -1531,6 +1693,8 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1531
1693
|
* Default: `false`
|
|
1532
1694
|
*/
|
|
1533
1695
|
consistentRead?: boolean;
|
|
1696
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
1697
|
+
includeAllowedDataPermissions?: boolean;
|
|
1534
1698
|
/**
|
|
1535
1699
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1536
1700
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2477,7 +2641,7 @@ interface AccountInfo {
|
|
|
2477
2641
|
* @returns Created collection.
|
|
2478
2642
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
|
|
2479
2643
|
*/
|
|
2480
|
-
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}.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>>;
|
|
2481
2645
|
/**
|
|
2482
2646
|
* Retrieves a data collection by ID.
|
|
2483
2647
|
*
|
|
@@ -2496,7 +2660,7 @@ declare function createDataCollection(collection: NonNullablePaths<DataCollectio
|
|
|
2496
2660
|
* @returns Requested collection.
|
|
2497
2661
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
|
|
2498
2662
|
*/
|
|
2499
|
-
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}.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>>;
|
|
2500
2664
|
interface GetDataCollectionOptions {
|
|
2501
2665
|
/**
|
|
2502
2666
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -2506,6 +2670,8 @@ interface GetDataCollectionOptions {
|
|
|
2506
2670
|
* Default: `false`
|
|
2507
2671
|
*/
|
|
2508
2672
|
consistentRead?: boolean;
|
|
2673
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2674
|
+
includeAllowedDataPermissions?: boolean;
|
|
2509
2675
|
/**
|
|
2510
2676
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2511
2677
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2527,7 +2693,7 @@ interface GetDataCollectionOptions {
|
|
|
2527
2693
|
* @applicableIdentity APP
|
|
2528
2694
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.ListDataCollections
|
|
2529
2695
|
*/
|
|
2530
|
-
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>>;
|
|
2531
2697
|
interface ListDataCollectionsOptions {
|
|
2532
2698
|
/**
|
|
2533
2699
|
* Defines how collections in the response are sorted.
|
|
@@ -2551,6 +2717,8 @@ interface ListDataCollectionsOptions {
|
|
|
2551
2717
|
* Default: `false`
|
|
2552
2718
|
*/
|
|
2553
2719
|
consistentRead?: boolean;
|
|
2720
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2721
|
+
includeAllowedDataPermissions?: boolean;
|
|
2554
2722
|
/**
|
|
2555
2723
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2556
2724
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2579,7 +2747,7 @@ interface ListDataCollectionsOptions {
|
|
|
2579
2747
|
* @applicableIdentity APP
|
|
2580
2748
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.BulkGetDataCollections
|
|
2581
2749
|
*/
|
|
2582
|
-
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>>;
|
|
2583
2751
|
interface BulkGetDataCollectionsOptions {
|
|
2584
2752
|
/**
|
|
2585
2753
|
* IDs of the collections to retrieve.
|
|
@@ -2616,6 +2784,8 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2616
2784
|
* Default: `false`
|
|
2617
2785
|
*/
|
|
2618
2786
|
consistentRead?: boolean;
|
|
2787
|
+
/** If set allowed for caller data permissions would be included in the response */
|
|
2788
|
+
includeAllowedDataPermissions?: boolean;
|
|
2619
2789
|
/**
|
|
2620
2790
|
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2621
2791
|
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
@@ -2663,7 +2833,7 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2663
2833
|
* @returns Updated collection details.
|
|
2664
2834
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollection
|
|
2665
2835
|
*/
|
|
2666
|
-
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}.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>>;
|
|
2667
2837
|
/**
|
|
2668
2838
|
* Deletes a data collection.
|
|
2669
2839
|
*
|
|
@@ -2694,7 +2864,7 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
|
|
|
2694
2864
|
* @applicableIdentity APP
|
|
2695
2865
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection
|
|
2696
2866
|
*/
|
|
2697
|
-
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}.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>>;
|
|
2698
2868
|
/**
|
|
2699
2869
|
* Updates specified properties of a data collection.
|
|
2700
2870
|
*
|
|
@@ -2713,7 +2883,7 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
|
|
|
2713
2883
|
* @applicableIdentity APP
|
|
2714
2884
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
|
|
2715
2885
|
*/
|
|
2716
|
-
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}.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>>;
|
|
2717
2887
|
interface PatchDataCollection {
|
|
2718
2888
|
/**
|
|
2719
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`.
|
|
@@ -2806,6 +2976,11 @@ interface PatchDataCollection {
|
|
|
2806
2976
|
* @readonly
|
|
2807
2977
|
*/
|
|
2808
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;
|
|
2809
2984
|
/**
|
|
2810
2985
|
* Deprecation metadata for this collection. App collections set this metadata to direct users to a replacement collection.
|
|
2811
2986
|
* @readonly
|
|
@@ -2825,7 +3000,7 @@ interface PatchDataCollection {
|
|
|
2825
3000
|
* @applicableIdentity APP
|
|
2826
3001
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollectionField
|
|
2827
3002
|
*/
|
|
2828
|
-
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}.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>>;
|
|
2829
3004
|
interface CreateDataCollectionFieldOptions {
|
|
2830
3005
|
/** New field to add. */
|
|
2831
3006
|
field: Field;
|
|
@@ -2852,7 +3027,7 @@ interface CreateDataCollectionFieldOptions {
|
|
|
2852
3027
|
* @applicableIdentity APP
|
|
2853
3028
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollectionField
|
|
2854
3029
|
*/
|
|
2855
|
-
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}.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>>;
|
|
2856
3031
|
interface UpdateDataCollectionFieldOptions {
|
|
2857
3032
|
/** Field to update. */
|
|
2858
3033
|
field: Field;
|
|
@@ -2871,7 +3046,7 @@ interface UpdateDataCollectionFieldOptions {
|
|
|
2871
3046
|
* @applicableIdentity APP
|
|
2872
3047
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionField
|
|
2873
3048
|
*/
|
|
2874
|
-
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}.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>>;
|
|
2875
3050
|
interface DeleteDataCollectionFieldOptions {
|
|
2876
3051
|
/**
|
|
2877
3052
|
* ID of the field to delete.
|
|
@@ -2893,7 +3068,7 @@ interface DeleteDataCollectionFieldOptions {
|
|
|
2893
3068
|
* @applicableIdentity APP
|
|
2894
3069
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDataCollectionPlugin
|
|
2895
3070
|
*/
|
|
2896
|
-
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}.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>>;
|
|
2897
3072
|
interface AddDataCollectionPluginOptions {
|
|
2898
3073
|
/**
|
|
2899
3074
|
* Plugin to add to the collection. Must include the plugin type and any type-specific configuration.
|
|
@@ -2914,7 +3089,7 @@ interface AddDataCollectionPluginOptions {
|
|
|
2914
3089
|
* @applicableIdentity APP
|
|
2915
3090
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionPlugin
|
|
2916
3091
|
*/
|
|
2917
|
-
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}.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>>;
|
|
2918
3093
|
interface DeleteDataCollectionPluginOptions {
|
|
2919
3094
|
/** Plugin type to remove. */
|
|
2920
3095
|
pluginType: PluginTypeWithLiterals;
|
|
@@ -2934,7 +3109,7 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2934
3109
|
* @applicableIdentity APP
|
|
2935
3110
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddPublishPlugin
|
|
2936
3111
|
*/
|
|
2937
|
-
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}.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>>;
|
|
2938
3113
|
interface AddPublishPluginOptions {
|
|
2939
3114
|
/** Publish plugin options. */
|
|
2940
3115
|
publishOptions: PublishPluginOptions;
|
|
@@ -2957,7 +3132,7 @@ interface AddPublishPluginOptions {
|
|
|
2957
3132
|
* @applicableIdentity APP
|
|
2958
3133
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeletePublishPlugin
|
|
2959
3134
|
*/
|
|
2960
|
-
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}.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>>;
|
|
2961
3136
|
/**
|
|
2962
3137
|
* Updates the Publish plugin options on a data collection.
|
|
2963
3138
|
*
|
|
@@ -2973,7 +3148,7 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
2973
3148
|
* @applicableIdentity APP
|
|
2974
3149
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdatePublishPlugin
|
|
2975
3150
|
*/
|
|
2976
|
-
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}.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>>;
|
|
2977
3152
|
interface UpdatePublishPluginOptions {
|
|
2978
3153
|
/**
|
|
2979
3154
|
* Replacement writable options for the Publish plugin. Omitted options use their defaults.
|
|
@@ -2996,7 +3171,7 @@ interface UpdatePublishPluginOptions {
|
|
|
2996
3171
|
* @applicableIdentity APP
|
|
2997
3172
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddUrlizedPlugin
|
|
2998
3173
|
*/
|
|
2999
|
-
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}.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>>;
|
|
3000
3175
|
interface AddUrlizedPluginOptions {
|
|
3001
3176
|
/** Urlized plugin options. */
|
|
3002
3177
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3013,7 +3188,7 @@ interface AddUrlizedPluginOptions {
|
|
|
3013
3188
|
* @applicableIdentity APP
|
|
3014
3189
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteUrlizedPlugin
|
|
3015
3190
|
*/
|
|
3016
|
-
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}.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>>;
|
|
3017
3192
|
/**
|
|
3018
3193
|
* Updates the Urlized plugin options on a data collection.
|
|
3019
3194
|
*
|
|
@@ -3029,7 +3204,7 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3029
3204
|
* @applicableIdentity APP
|
|
3030
3205
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateUrlizedPlugin
|
|
3031
3206
|
*/
|
|
3032
|
-
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}.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>>;
|
|
3033
3208
|
interface UpdateUrlizedPluginOptions {
|
|
3034
3209
|
/** Replacement options for the Urlized plugin. Omitted options use their defaults. */
|
|
3035
3210
|
urlizedOptions: UrlizedPluginOptions;
|
|
@@ -3049,7 +3224,7 @@ interface UpdateUrlizedPluginOptions {
|
|
|
3049
3224
|
* @applicableIdentity APP
|
|
3050
3225
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddMultilingualPlugin
|
|
3051
3226
|
*/
|
|
3052
|
-
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}.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>>;
|
|
3053
3228
|
interface AddMultilingualPluginOptions {
|
|
3054
3229
|
/** Multilingual plugin options. */
|
|
3055
3230
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3066,7 +3241,7 @@ interface AddMultilingualPluginOptions {
|
|
|
3066
3241
|
* @applicableIdentity APP
|
|
3067
3242
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteMultilingualPlugin
|
|
3068
3243
|
*/
|
|
3069
|
-
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}.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>>;
|
|
3070
3245
|
/**
|
|
3071
3246
|
* Updates the Multilingual plugin options on a data collection.
|
|
3072
3247
|
*
|
|
@@ -3082,7 +3257,7 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
|
|
|
3082
3257
|
* @applicableIdentity APP
|
|
3083
3258
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateMultilingualPlugin
|
|
3084
3259
|
*/
|
|
3085
|
-
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}.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>>;
|
|
3086
3261
|
interface UpdateMultilingualPluginOptions {
|
|
3087
3262
|
/** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
|
|
3088
3263
|
multilingualOptions: MultilingualOptions;
|
|
@@ -3102,7 +3277,7 @@ interface UpdateMultilingualPluginOptions {
|
|
|
3102
3277
|
* @applicableIdentity APP
|
|
3103
3278
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCmsPlugin
|
|
3104
3279
|
*/
|
|
3105
|
-
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}.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>>;
|
|
3106
3281
|
interface AddCmsPluginOptions {
|
|
3107
3282
|
/** CMS plugin options. */
|
|
3108
3283
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3119,7 +3294,7 @@ interface AddCmsPluginOptions {
|
|
|
3119
3294
|
* @applicableIdentity APP
|
|
3120
3295
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCmsPlugin
|
|
3121
3296
|
*/
|
|
3122
|
-
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}.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>>;
|
|
3123
3298
|
/**
|
|
3124
3299
|
* Updates the CMS plugin options on a data collection.
|
|
3125
3300
|
*
|
|
@@ -3135,7 +3310,7 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
|
|
|
3135
3310
|
* @applicableIdentity APP
|
|
3136
3311
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCmsPlugin
|
|
3137
3312
|
*/
|
|
3138
|
-
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}.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>>;
|
|
3139
3314
|
interface UpdateCmsPluginOptions {
|
|
3140
3315
|
/** Replacement options for the CMS plugin. Omitted options use their defaults. */
|
|
3141
3316
|
cmsOptions: PluginCmsOptions;
|
|
@@ -3155,7 +3330,7 @@ interface UpdateCmsPluginOptions {
|
|
|
3155
3330
|
* @applicableIdentity APP
|
|
3156
3331
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCatalogPlugin
|
|
3157
3332
|
*/
|
|
3158
|
-
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}.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>>;
|
|
3159
3334
|
interface AddCatalogPluginOptions {
|
|
3160
3335
|
/** Catalog plugin options. */
|
|
3161
3336
|
catalogOptions: CatalogOptions;
|
|
@@ -3172,7 +3347,7 @@ interface AddCatalogPluginOptions {
|
|
|
3172
3347
|
* @applicableIdentity APP
|
|
3173
3348
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCatalogPlugin
|
|
3174
3349
|
*/
|
|
3175
|
-
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}.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>>;
|
|
3176
3351
|
/**
|
|
3177
3352
|
* Updates the Catalog plugin options on a data collection.
|
|
3178
3353
|
*
|
|
@@ -3188,7 +3363,7 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
3188
3363
|
* @applicableIdentity APP
|
|
3189
3364
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCatalogPlugin
|
|
3190
3365
|
*/
|
|
3191
|
-
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}.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>>;
|
|
3192
3367
|
interface UpdateCatalogPluginOptions {
|
|
3193
3368
|
/** Replacement options for the Catalog plugin. Omitted options use their defaults. */
|
|
3194
3369
|
catalogOptions: CatalogOptions;
|
|
@@ -3208,7 +3383,7 @@ interface UpdateCatalogPluginOptions {
|
|
|
3208
3383
|
* @applicableIdentity APP
|
|
3209
3384
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDraftItemsPlugin
|
|
3210
3385
|
*/
|
|
3211
|
-
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}.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>>;
|
|
3212
3387
|
interface AddDraftItemsPluginOptions {
|
|
3213
3388
|
/** Draft Items plugin options. */
|
|
3214
3389
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
@@ -3232,7 +3407,7 @@ interface AddDraftItemsPluginOptions {
|
|
|
3232
3407
|
* @applicableIdentity APP
|
|
3233
3408
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDraftItemsPlugin
|
|
3234
3409
|
*/
|
|
3235
|
-
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}.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>>;
|
|
3236
3411
|
interface DeleteDraftItemsPluginOptions {
|
|
3237
3412
|
/**
|
|
3238
3413
|
* Action to take for existing draft items.
|
|
@@ -3256,7 +3431,7 @@ interface DeleteDraftItemsPluginOptions {
|
|
|
3256
3431
|
* @applicableIdentity APP
|
|
3257
3432
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDraftItemsPlugin
|
|
3258
3433
|
*/
|
|
3259
|
-
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}.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>>;
|
|
3260
3435
|
interface UpdateDraftItemsPluginOptions {
|
|
3261
3436
|
/**
|
|
3262
3437
|
* Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
|
|
@@ -3279,6 +3454,6 @@ interface UpdateDraftItemsPluginOptions {
|
|
|
3279
3454
|
* @applicableIdentity APP
|
|
3280
3455
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollectionField
|
|
3281
3456
|
*/
|
|
3282
|
-
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}.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>>;
|
|
3283
3458
|
|
|
3284
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 };
|