@wix/auto_sdk_data_collections 1.0.112 → 1.0.114
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 +32 -32
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +166 -50
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +124 -19
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +32 -32
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +166 -50
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +124 -19
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +32 -32
- package/build/internal/cjs/index.typings.d.ts +95 -271
- package/build/internal/cjs/meta.d.ts +61 -227
- package/build/internal/es/index.d.mts +32 -32
- package/build/internal/es/index.typings.d.mts +95 -271
- package/build/internal/es/meta.d.mts +61 -227
- package/package.json +2 -2
package/build/es/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { DataCollection, GetDataCollectionOptions, ListDataCollectionsOptions, ListDataCollectionsResponse, BulkGetDataCollectionsOptions, BulkGetDataCollectionsResponse, RestoreDataCollectionResponse, PatchDataCollection, PatchDataCollectionResponse, CreateDataCollectionFieldOptions, CreateDataCollectionFieldResponse, UpdateDataCollectionFieldOptions, UpdateDataCollectionFieldResponse, DeleteDataCollectionFieldOptions, DeleteDataCollectionFieldResponse, AddDataCollectionPluginOptions, AddDataCollectionPluginResponse, DeleteDataCollectionPluginOptions, DeleteDataCollectionPluginResponse, AddPublishPluginOptions, AddPublishPluginResponse, DeletePublishPluginResponse, UpdatePublishPluginOptions, UpdatePublishPluginResponse, AddUrlizedPluginOptions, AddUrlizedPluginResponse, DeleteUrlizedPluginResponse, UpdateUrlizedPluginOptions, UpdateUrlizedPluginResponse, AddMultilingualPluginOptions, AddMultilingualPluginResponse, DeleteMultilingualPluginResponse, UpdateMultilingualPluginOptions, UpdateMultilingualPluginResponse, AddCmsPluginOptions, AddCmsPluginResponse, DeleteCmsPluginResponse, UpdateCmsPluginOptions, UpdateCmsPluginResponse, AddCatalogPluginOptions, AddCatalogPluginResponse, DeleteCatalogPluginResponse, UpdateCatalogPluginOptions, UpdateCatalogPluginResponse, AddDraftItemsPluginOptions, AddDraftItemsPluginResponse, DeleteDraftItemsPluginOptions, DeleteDraftItemsPluginResponse, UpdateDraftItemsPluginOptions, UpdateDraftItemsPluginResponse, Field, PatchDataCollectionFieldResponse } from './index.typings.mjs';
|
|
3
|
-
export { AccessLevel, AccessLevelWithLiterals, AccountInfo, ActionEvent, AddCatalogPluginRequest, AddCmsPluginRequest, AddDataCollectionPluginRequest, AddDraftItemsPluginRequest, AddMultilingualPluginRequest, AddPublishPluginRequest, AddUrlizedPluginRequest, Address, AllowedDataPermissions, AllowedDraftPermissions, AppOptions, ApplicationError, ArrayDocument, ArraySizeRange, ArrayString, Audio, BulkGetDataCollectionsPageBySnapshotsRequest, BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, BulkGetDataCollectionsPageBySnapshotsResponse, BulkGetDataCollectionsRequest, Calculator, CalculatorPatternOneOf, CatalogOptions, CategoryFieldOptions, CmsOptions, CollectionCapabilities, CollectionDefinition, CollectionOperation, CollectionOperationWithLiterals, CollectionType, CollectionTypeWithLiterals, CreateAppCollectionsSnapshotRequest, CreateAppCollectionsSnapshotResponse, CreateDataCollectionFieldRequest, CreateDataCollectionRequest, CreateDataCollectionResponse, CreateDataCollectionsSnapshotRequest, CreateDataCollectionsSnapshotResponse, CreateMigratedCollectionsSnapshotRequest, CreateMigratedCollectionsSnapshotResponse, DataCollectionChangedEvent, DataCollectionClonedEvent, DataCollectionEvictedEvent, DataOperation, DataOperationWithLiterals, DataPermissions, Datetime, DatetimeDefaultValueOneOf, DatetimeMaxDateOneOf, DatetimeMinDateOneOf, DeleteCatalogPluginRequest, DeleteCmsPluginRequest, DeleteDataCollectionFieldRequest, DeleteDataCollectionPluginRequest, DeleteDataCollectionRequest, DeleteDataCollectionResponse, DeleteDataCollectionsSnapshotRequest, DeleteDataCollectionsSnapshotResponse, DeleteDraftItemsPluginRequest, DeleteMultilingualPluginRequest, DeletePublishPluginRequest, DeleteUrlizedPluginRequest, Deprecation, Destination, Direction, DirectionWithLiterals, Document, DomainEvent, DomainEventBodyOneOf, DraftItemsPluginConflictAction, DraftItemsPluginConflictActionWithLiterals, DraftItemsPluginOptions,
|
|
3
|
+
export { AccessLevel, AccessLevelWithLiterals, AccountInfo, ActionEvent, AddCatalogPluginRequest, AddCmsPluginRequest, AddDataCollectionPluginRequest, AddDraftItemsPluginRequest, AddMultilingualPluginRequest, AddPublishPluginRequest, AddUrlizedPluginRequest, Address, AllowedDataPermissions, AllowedDraftPermissions, AppOptions, ApplicationError, ArrayDocument, ArraySizeRange, ArrayString, Audio, BulkGetDataCollectionsPageBySnapshotsRequest, BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, BulkGetDataCollectionsPageBySnapshotsResponse, BulkGetDataCollectionsRequest, Calculator, CalculatorPatternOneOf, CatalogOptions, CategoryFieldOptions, CmsOptions, CollectionCapabilities, CollectionDefinition, CollectionOperation, CollectionOperationWithLiterals, CollectionType, CollectionTypeWithLiterals, CreateAppCollectionsSnapshotRequest, CreateAppCollectionsSnapshotResponse, CreateDataCollectionFieldRequest, CreateDataCollectionRequest, CreateDataCollectionResponse, CreateDataCollectionsSnapshotRequest, CreateDataCollectionsSnapshotResponse, CreateMigratedCollectionsSnapshotRequest, CreateMigratedCollectionsSnapshotResponse, DataCollectionChangedEvent, DataCollectionClonedEvent, DataCollectionEvictedEvent, DataOperation, DataOperationWithLiterals, DataPermissions, Datetime, DatetimeDefaultValueOneOf, DatetimeMaxDateOneOf, DatetimeMinDateOneOf, DeleteCatalogPluginRequest, DeleteCmsPluginRequest, DeleteDataCollectionFieldRequest, DeleteDataCollectionPluginRequest, DeleteDataCollectionRequest, DeleteDataCollectionResponse, DeleteDataCollectionsSnapshotRequest, DeleteDataCollectionsSnapshotResponse, DeleteDraftItemsPluginRequest, DeleteMultilingualPluginRequest, DeletePublishPluginRequest, DeleteUrlizedPluginRequest, Deprecation, Destination, Direction, DirectionWithLiterals, Document, DomainEvent, DomainEventBodyOneOf, DraftItemsPluginConflictAction, DraftItemsPluginConflictActionWithLiterals, DraftItemsPluginOptions, DraftItemsRemovalAction, DraftItemsRemovalActionWithLiterals, DraftPermissions, Email, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EnumValues, FailedCollection, Failure, FieldCapabilities, FieldCondition, FieldPlugin, FieldPluginOptionsOneOf, FieldPluginType, FieldPluginTypeWithLiterals, FieldRangeValidationsOneOf, FieldUpdate, FieldsPattern, Format, FormatWithLiterals, GetDataCollectionRequest, GetDataCollectionResponse, IdentificationData, IdentificationDataIdOneOf, Image, Index, IndexField, IndexLimits, IndexQuotaLimits, IndexSource, IndexSourceWithLiterals, IndexStatus, IndexStatusWithLiterals, LegacyColor, LifecycleStatus, LifecycleStatusWithLiterals, ListDataCollectionsRequest, MediaGallery, MediaImage, MessageEnvelope, MultiReference, MultilingualOptions, NumberRange, ObjectField, Order, OrderWithLiterals, PageLink, PageLinkPluginOptions, PageLinkType, PageLinkTypeWithLiterals, Paging, PagingMetadataV2, PagingMode, PagingModeWithLiterals, PatchDataCollectionFieldRequest, PatchDataCollectionRequest, Permission, PermissionWithLiterals, Permissions, PermissionsUpdate, Plugin, PluginCmsOptions, PluginOptionsOneOf, PluginType, PluginTypeWithLiterals, PluginUpdate, PublishPluginConflictAction, PublishPluginConflictActionWithLiterals, PublishPluginOptions, QueryOperator, QueryOperatorWithLiterals, Reference, RestorationCollection, RestoreDataCollectionRequest, RestoreDataCollectionsFromSnapshotRequest, RestoreDataCollectionsFromSnapshotResponse, RestoreInfo, RichContent, RichText, Role, RoleWithLiterals, Segment, SegmentWithLiterals, SingleItemPluginOptions, SiteSort, Slug, SnapshotCollection, Sort, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, StrictModeUpdate, StringLengthRange, TenantMode, TenantModeWithLiterals, Text, TextValidation, TextValidationOneOf, Time, Type, TypeMetadata, TypeMetadataMetadataOneOf, TypeWithLiterals, UpdateCatalogPluginRequest, UpdateCmsPluginRequest, UpdateDataCollectionFieldRequest, UpdateDataCollectionRequest, UpdateDataCollectionResponse, UpdateDataPermissionsRequest, UpdateDataPermissionsResponse, UpdateDraftItemsPluginRequest, UpdateMultilingualPluginRequest, UpdatePublishPluginRequest, UpdateUrlizedPluginRequest, Url, UrlizedOnlyPattern, UrlizedPluginOptions, Video, WebhookIdentityType, WebhookIdentityTypeWithLiterals, _Array, _Boolean, _Date, _DateDefaultValueOneOf, _DateMaxDateOneOf, _DateMinDateOneOf, _Number, _Object } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createDataCollection$1(httpClient: HttpClient): CreateDataCollectionSignature;
|
|
6
6
|
interface CreateDataCollectionSignature {
|
|
@@ -12,7 +12,7 @@ interface CreateDataCollectionSignature {
|
|
|
12
12
|
* @param - Options for creating a data collection.
|
|
13
13
|
* @returns Created collection.
|
|
14
14
|
*/
|
|
15
|
-
(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
15
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
16
16
|
}
|
|
17
17
|
declare function getDataCollection$1(httpClient: HttpClient): GetDataCollectionSignature;
|
|
18
18
|
interface GetDataCollectionSignature {
|
|
@@ -29,7 +29,7 @@ interface GetDataCollectionSignature {
|
|
|
29
29
|
* @param - Options for retrieving a data collection.
|
|
30
30
|
* @returns Requested collection.
|
|
31
31
|
*/
|
|
32
|
-
(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
32
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
33
33
|
}
|
|
34
34
|
declare function listDataCollections$1(httpClient: HttpClient): ListDataCollectionsSignature;
|
|
35
35
|
interface ListDataCollectionsSignature {
|
|
@@ -41,7 +41,7 @@ interface ListDataCollectionsSignature {
|
|
|
41
41
|
* To retrieve the next page, increase `paging.offset` by the number of collections returned.
|
|
42
42
|
* @param - Options for retrieving a list of data collections.
|
|
43
43
|
*/
|
|
44
|
-
(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>>;
|
|
44
|
+
(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>>;
|
|
45
45
|
}
|
|
46
46
|
declare function bulkGetDataCollections$1(httpClient: HttpClient): BulkGetDataCollectionsSignature;
|
|
47
47
|
interface BulkGetDataCollectionsSignature {
|
|
@@ -59,7 +59,7 @@ interface BulkGetDataCollectionsSignature {
|
|
|
59
59
|
*
|
|
60
60
|
* To retrieve a single collection, call [Get Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/get-data-collection).
|
|
61
61
|
*/
|
|
62
|
-
(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>>;
|
|
62
|
+
(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>>;
|
|
63
63
|
}
|
|
64
64
|
declare function updateDataCollection$1(httpClient: HttpClient): UpdateDataCollectionSignature;
|
|
65
65
|
interface UpdateDataCollectionSignature {
|
|
@@ -88,7 +88,7 @@ interface UpdateDataCollectionSignature {
|
|
|
88
88
|
* @param - Options for updating a data collection.
|
|
89
89
|
* @returns Updated collection details.
|
|
90
90
|
*/
|
|
91
|
-
(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update` | `revision`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.catalogOptions.name` | `plugins.${number}.catalogOptions.price` | `plugins.${number}.catalogOptions.nameFieldKey` | `plugins.${number}.catalogOptions.priceFieldKey` | `plugins.${number}.draftItemsOptions.draftsCollectionId` | `plugins.${number}.draftItemsOptions.publishedCollectionId` | `plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
91
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `plugins.${number}.type` | `pagingModes` | `allowedDataPermissions.itemRead` | `allowedDataPermissions.itemInsert` | `allowedDataPermissions.itemUpdate` | `allowedDataPermissions.itemRemove` | `deprecation.deprecated`, 4>>;
|
|
92
92
|
}
|
|
93
93
|
declare function deleteDataCollection$1(httpClient: HttpClient): DeleteDataCollectionSignature;
|
|
94
94
|
interface DeleteDataCollectionSignature {
|
|
@@ -114,7 +114,7 @@ interface RestoreDataCollectionSignature {
|
|
|
114
114
|
* Fails with `WDE0025` if collection was deleted too long ago or has never existed.
|
|
115
115
|
* @param - ID of the data collection to restore.
|
|
116
116
|
*/
|
|
117
|
-
(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
117
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
118
118
|
}
|
|
119
119
|
declare function patchDataCollection$1(httpClient: HttpClient): PatchDataCollectionSignature;
|
|
120
120
|
interface PatchDataCollectionSignature {
|
|
@@ -130,7 +130,7 @@ interface PatchDataCollectionSignature {
|
|
|
130
130
|
* @param - [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`.
|
|
131
131
|
* For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
|
|
132
132
|
*/
|
|
133
|
-
(_id: string, dataCollection: PatchDataCollection): Promise<NonNullablePaths<PatchDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
133
|
+
(_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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
134
134
|
}
|
|
135
135
|
declare function createDataCollectionField$1(httpClient: HttpClient): CreateDataCollectionFieldSignature;
|
|
136
136
|
interface CreateDataCollectionFieldSignature {
|
|
@@ -138,7 +138,7 @@ interface CreateDataCollectionFieldSignature {
|
|
|
138
138
|
* Adds a new field to the structure of a data collection.
|
|
139
139
|
* @param - ID of the data collection to update.
|
|
140
140
|
*/
|
|
141
|
-
(dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
141
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
142
142
|
}
|
|
143
143
|
declare function updateDataCollectionField$1(httpClient: HttpClient): UpdateDataCollectionFieldSignature;
|
|
144
144
|
interface UpdateDataCollectionFieldSignature {
|
|
@@ -155,7 +155,7 @@ interface UpdateDataCollectionFieldSignature {
|
|
|
155
155
|
* </blockquote>
|
|
156
156
|
* @param - ID of the data collection to update.
|
|
157
157
|
*/
|
|
158
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 1>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
158
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
159
159
|
}
|
|
160
160
|
declare function deleteDataCollectionField$1(httpClient: HttpClient): DeleteDataCollectionFieldSignature;
|
|
161
161
|
interface DeleteDataCollectionFieldSignature {
|
|
@@ -166,7 +166,7 @@ interface DeleteDataCollectionFieldSignature {
|
|
|
166
166
|
* from all items in the collection.
|
|
167
167
|
* @param - ID of the data collection to update.
|
|
168
168
|
*/
|
|
169
|
-
(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`, 0>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
169
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
170
170
|
}
|
|
171
171
|
declare function addDataCollectionPlugin$1(httpClient: HttpClient): AddDataCollectionPluginSignature;
|
|
172
172
|
interface AddDataCollectionPluginSignature {
|
|
@@ -176,7 +176,7 @@ interface AddDataCollectionPluginSignature {
|
|
|
176
176
|
* If a plugin of the same type already exists in the collection, this operation fails.
|
|
177
177
|
* @param - ID of the data collection to update.
|
|
178
178
|
*/
|
|
179
|
-
(dataCollectionId: string, options: NonNullablePaths<AddDataCollectionPluginOptions, `plugin` | `plugin.type`, 1>): Promise<NonNullablePaths<AddDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
179
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
180
180
|
}
|
|
181
181
|
declare function deleteDataCollectionPlugin$1(httpClient: HttpClient): DeleteDataCollectionPluginSignature;
|
|
182
182
|
interface DeleteDataCollectionPluginSignature {
|
|
@@ -186,7 +186,7 @@ interface DeleteDataCollectionPluginSignature {
|
|
|
186
186
|
* Removing a plugin disables its functionality for the collection.
|
|
187
187
|
* @param - ID of the data collection to update.
|
|
188
188
|
*/
|
|
189
|
-
(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionPluginOptions, `pluginType`, 0>): Promise<NonNullablePaths<DeleteDataCollectionPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
189
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
190
190
|
}
|
|
191
191
|
declare function addPublishPlugin$1(httpClient: HttpClient): AddPublishPluginSignature;
|
|
192
192
|
interface AddPublishPluginSignature {
|
|
@@ -198,7 +198,7 @@ interface AddPublishPluginSignature {
|
|
|
198
198
|
* @param - Publish plugin options.
|
|
199
199
|
* @param - Options for adding the Publish plugin.
|
|
200
200
|
*/
|
|
201
|
-
(dataCollectionId: string, options?: NonNullablePaths<AddPublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<AddPublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
201
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
202
202
|
}
|
|
203
203
|
declare function deletePublishPlugin$1(httpClient: HttpClient): DeletePublishPluginSignature;
|
|
204
204
|
interface DeletePublishPluginSignature {
|
|
@@ -208,7 +208,7 @@ interface DeletePublishPluginSignature {
|
|
|
208
208
|
* Fails if the collection doesn't have this plugin.
|
|
209
209
|
* @param - ID of the data collection to update.
|
|
210
210
|
*/
|
|
211
|
-
(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
211
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
212
212
|
}
|
|
213
213
|
declare function updatePublishPlugin$1(httpClient: HttpClient): UpdatePublishPluginSignature;
|
|
214
214
|
interface UpdatePublishPluginSignature {
|
|
@@ -219,7 +219,7 @@ interface UpdatePublishPluginSignature {
|
|
|
219
219
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
220
220
|
* @param - ID of the data collection to update.
|
|
221
221
|
*/
|
|
222
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
222
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
223
223
|
}
|
|
224
224
|
declare function addUrlizedPlugin$1(httpClient: HttpClient): AddUrlizedPluginSignature;
|
|
225
225
|
interface AddUrlizedPluginSignature {
|
|
@@ -230,7 +230,7 @@ interface AddUrlizedPluginSignature {
|
|
|
230
230
|
* @param - ID of the data collection to update.
|
|
231
231
|
* @param - Urlized plugin options.
|
|
232
232
|
*/
|
|
233
|
-
(dataCollectionId: string, options: NonNullablePaths<AddUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<AddUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
233
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
234
234
|
}
|
|
235
235
|
declare function deleteUrlizedPlugin$1(httpClient: HttpClient): DeleteUrlizedPluginSignature;
|
|
236
236
|
interface DeleteUrlizedPluginSignature {
|
|
@@ -240,7 +240,7 @@ interface DeleteUrlizedPluginSignature {
|
|
|
240
240
|
* Fails if the collection doesn't have this plugin.
|
|
241
241
|
* @param - ID of the data collection to update.
|
|
242
242
|
*/
|
|
243
|
-
(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
243
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
244
244
|
}
|
|
245
245
|
declare function updateUrlizedPlugin$1(httpClient: HttpClient): UpdateUrlizedPluginSignature;
|
|
246
246
|
interface UpdateUrlizedPluginSignature {
|
|
@@ -251,7 +251,7 @@ interface UpdateUrlizedPluginSignature {
|
|
|
251
251
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
252
252
|
* @param - ID of the data collection to update.
|
|
253
253
|
*/
|
|
254
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
254
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
255
255
|
}
|
|
256
256
|
declare function addMultilingualPlugin$1(httpClient: HttpClient): AddMultilingualPluginSignature;
|
|
257
257
|
interface AddMultilingualPluginSignature {
|
|
@@ -262,7 +262,7 @@ interface AddMultilingualPluginSignature {
|
|
|
262
262
|
* @param - ID of the data collection to update.
|
|
263
263
|
* @param - Multilingual plugin options.
|
|
264
264
|
*/
|
|
265
|
-
(dataCollectionId: string, options: NonNullablePaths<AddMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<AddMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
265
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
266
266
|
}
|
|
267
267
|
declare function deleteMultilingualPlugin$1(httpClient: HttpClient): DeleteMultilingualPluginSignature;
|
|
268
268
|
interface DeleteMultilingualPluginSignature {
|
|
@@ -272,7 +272,7 @@ interface DeleteMultilingualPluginSignature {
|
|
|
272
272
|
* Fails if the collection doesn't have this plugin.
|
|
273
273
|
* @param - ID of the data collection to update.
|
|
274
274
|
*/
|
|
275
|
-
(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
275
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
276
276
|
}
|
|
277
277
|
declare function updateMultilingualPlugin$1(httpClient: HttpClient): UpdateMultilingualPluginSignature;
|
|
278
278
|
interface UpdateMultilingualPluginSignature {
|
|
@@ -283,7 +283,7 @@ interface UpdateMultilingualPluginSignature {
|
|
|
283
283
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
284
284
|
* @param - ID of the data collection to update.
|
|
285
285
|
*/
|
|
286
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
286
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
287
287
|
}
|
|
288
288
|
declare function addCmsPlugin$1(httpClient: HttpClient): AddCmsPluginSignature;
|
|
289
289
|
interface AddCmsPluginSignature {
|
|
@@ -294,7 +294,7 @@ interface AddCmsPluginSignature {
|
|
|
294
294
|
* @param - ID of the data collection to update.
|
|
295
295
|
* @param - CMS plugin options.
|
|
296
296
|
*/
|
|
297
|
-
(dataCollectionId: string, options: NonNullablePaths<AddCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<AddCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
297
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
298
298
|
}
|
|
299
299
|
declare function deleteCmsPlugin$1(httpClient: HttpClient): DeleteCmsPluginSignature;
|
|
300
300
|
interface DeleteCmsPluginSignature {
|
|
@@ -304,7 +304,7 @@ interface DeleteCmsPluginSignature {
|
|
|
304
304
|
* Fails if the collection doesn't have this plugin.
|
|
305
305
|
* @param - ID of the data collection to update.
|
|
306
306
|
*/
|
|
307
|
-
(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
307
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
308
308
|
}
|
|
309
309
|
declare function updateCmsPlugin$1(httpClient: HttpClient): UpdateCmsPluginSignature;
|
|
310
310
|
interface UpdateCmsPluginSignature {
|
|
@@ -315,7 +315,7 @@ interface UpdateCmsPluginSignature {
|
|
|
315
315
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
316
316
|
* @param - ID of the data collection to update.
|
|
317
317
|
*/
|
|
318
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
318
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
319
319
|
}
|
|
320
320
|
declare function addCatalogPlugin$1(httpClient: HttpClient): AddCatalogPluginSignature;
|
|
321
321
|
interface AddCatalogPluginSignature {
|
|
@@ -326,7 +326,7 @@ interface AddCatalogPluginSignature {
|
|
|
326
326
|
* @param - ID of the data collection to update.
|
|
327
327
|
* @param - Catalog plugin options.
|
|
328
328
|
*/
|
|
329
|
-
(dataCollectionId: string, options: NonNullablePaths<AddCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<AddCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
329
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
330
330
|
}
|
|
331
331
|
declare function deleteCatalogPlugin$1(httpClient: HttpClient): DeleteCatalogPluginSignature;
|
|
332
332
|
interface DeleteCatalogPluginSignature {
|
|
@@ -336,7 +336,7 @@ interface DeleteCatalogPluginSignature {
|
|
|
336
336
|
* Fails if the collection doesn't have this plugin.
|
|
337
337
|
* @param - ID of the data collection to update.
|
|
338
338
|
*/
|
|
339
|
-
(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
339
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
340
340
|
}
|
|
341
341
|
declare function updateCatalogPlugin$1(httpClient: HttpClient): UpdateCatalogPluginSignature;
|
|
342
342
|
interface UpdateCatalogPluginSignature {
|
|
@@ -347,7 +347,7 @@ interface UpdateCatalogPluginSignature {
|
|
|
347
347
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
348
348
|
* @param - ID of the data collection to update.
|
|
349
349
|
*/
|
|
350
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
350
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
351
351
|
}
|
|
352
352
|
declare function addDraftItemsPlugin$1(httpClient: HttpClient): AddDraftItemsPluginSignature;
|
|
353
353
|
interface AddDraftItemsPluginSignature {
|
|
@@ -359,7 +359,7 @@ interface AddDraftItemsPluginSignature {
|
|
|
359
359
|
* @param - Draft Items plugin options.
|
|
360
360
|
* @param - Options for adding the Draft Items plugin.
|
|
361
361
|
*/
|
|
362
|
-
(dataCollectionId: string, options?: NonNullablePaths<AddDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<AddDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
362
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
363
363
|
}
|
|
364
364
|
declare function deleteDraftItemsPlugin$1(httpClient: HttpClient): DeleteDraftItemsPluginSignature;
|
|
365
365
|
interface DeleteDraftItemsPluginSignature {
|
|
@@ -370,7 +370,7 @@ interface DeleteDraftItemsPluginSignature {
|
|
|
370
370
|
* @param - ID of the data collection to update.
|
|
371
371
|
* @param - Options for removing the Draft Items plugin.
|
|
372
372
|
*/
|
|
373
|
-
(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
373
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
374
374
|
}
|
|
375
375
|
declare function updateDraftItemsPlugin$1(httpClient: HttpClient): UpdateDraftItemsPluginSignature;
|
|
376
376
|
interface UpdateDraftItemsPluginSignature {
|
|
@@ -381,7 +381,7 @@ interface UpdateDraftItemsPluginSignature {
|
|
|
381
381
|
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
382
382
|
* @param - ID of the data collection to update.
|
|
383
383
|
*/
|
|
384
|
-
(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
384
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
385
385
|
}
|
|
386
386
|
declare function patchDataCollectionField$1(httpClient: HttpClient): PatchDataCollectionFieldSignature;
|
|
387
387
|
interface PatchDataCollectionFieldSignature {
|
|
@@ -394,7 +394,7 @@ interface PatchDataCollectionFieldSignature {
|
|
|
394
394
|
* @param - ID of the data collection to update.
|
|
395
395
|
* @param - Field to update. Specify `key` to identify the existing field.
|
|
396
396
|
*/
|
|
397
|
-
(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.catalogOptions.name` | `dataCollection.plugins.${number}.catalogOptions.price` | `dataCollection.plugins.${number}.catalogOptions.nameFieldKey` | `dataCollection.plugins.${number}.catalogOptions.priceFieldKey` | `dataCollection.plugins.${number}.draftItemsOptions.draftsCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.publishedCollectionId` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.draftPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.manageDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.managePublishStatus` | `dataCollection.plugins.${number}.draftItemsOptions.allowedPermissions.viewDrafts` | `dataCollection.plugins.${number}.draftItemsOptions.allowWritesToPublishedCollection` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
397
|
+
(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}.draftItemsOptions.draftsAndPublishedCollectionId` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.allowedDataPermissions.itemRead` | `dataCollection.allowedDataPermissions.itemInsert` | `dataCollection.allowedDataPermissions.itemUpdate` | `dataCollection.allowedDataPermissions.itemRemove` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
398
398
|
}
|
|
399
399
|
|
|
400
400
|
declare const createDataCollection: MaybeContext<BuildRESTFunction<typeof createDataCollection$1> & typeof createDataCollection$1>;
|