@wix/auto_sdk_data_collections 1.0.108 → 1.0.109

package/build/internal/cjs/index.typings.d.ts

@@ -1,6 +1,9 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
-/** A data collection determines the structure of data to be stored in a database. */
+/**
+ * A data collection defines the fields, data types, item permissions, and plugins for a set of data items.
+ * Use the Data Items API to store and retrieve the items themselves.
+ */
 interface DataCollection {
     /**
      * [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`.
@@ -30,6 +33,8 @@ interface DataCollection {
     maxPageSize?: number | null;
     /**
      * Collection's display name as shown in the CMS. For example, `My First Collection`.
+     *
+     * Default: The collection ID.
      * @maxLength 1000
      */
     displayName?: string | null;
@@ -47,6 +52,8 @@ interface DataCollection {
     displayNamespace?: string | null;
     /**
      * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
+     *
+     * Default: The first field in the request, or `title` if no fields are specified.
      * @maxLength 1000
      */
     displayField?: string | null;
@@ -95,7 +102,7 @@ interface DataCollection {
      */
     dataPermissions?: DataPermissions;
     /**
-     * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
+     * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
      * @internal
      * @readonly
      */
@@ -247,7 +254,7 @@ interface Field extends FieldRangeValidationsOneOf {
      * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
      */
     type?: TypeWithLiterals;
-    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
     typeMetadata?: TypeMetadata;
     /**
      * Whether the field is a system field.
@@ -267,6 +274,7 @@ interface Field extends FieldRangeValidationsOneOf {
      */
     description?: string | null;
     /**
+     * Plugin that manages this field.
      * @internal
      * @maxLength 100
      */
@@ -278,7 +286,7 @@ interface Field extends FieldRangeValidationsOneOf {
      */
     readOnly?: boolean | null;
     /**
-     * Whether the field is immutable. An immutable field can be set once, but then cannot be updated.
+     * Whether the field is immutable. An immutable field can be set once, but then can't be updated.
      *
      * Default: `false`
      */
@@ -301,7 +309,7 @@ interface Field extends FieldRangeValidationsOneOf {
      */
     deleted?: boolean | null;
     /**
-     * This indicates that this fields is conditional and is not retrieved by default.
+     * Conditions that control whether this field is included when retrieving data items.
      * @readonly
      */
     condition?: FieldCondition;
@@ -710,7 +718,7 @@ interface ObjectField {
      * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
      */
     type?: TypeWithLiterals;
-    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
     typeMetadata?: TypeMetadata;
     /**
      * Capabilities the object field supports.
@@ -719,12 +727,19 @@ interface ObjectField {
     capabilities?: FieldCapabilities;
 }
 interface FieldsPattern {
-    /** @maxLength 1000 */
+    /**
+     * Pattern used to generate the field value from item properties.
+     * @maxLength 1000
+     */
     pattern?: string;
+    /** Whether to convert the generated value to lowercase. Default: `false`. */
     lowercase?: boolean;
 }
 interface UrlizedOnlyPattern {
-    /** @maxLength 1000 */
+    /**
+     * Pattern used to generate the field value from item properties.
+     * @maxLength 1000
+     */
     pattern?: string;
 }
 interface Calculator extends CalculatorPatternOneOf {
@@ -789,13 +804,16 @@ interface _Object {
      * @maxSize 1000
      */
     fields?: ObjectField[];
-    /** @internal */
+    /**
+     * Value assigned when a data item omits this field.
+     * @internal
+     */
     defaultValue?: Record<string, any> | null;
 }
 interface _Array {
     /** Element's data type. */
     elementType?: TypeWithLiterals;
-    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
     typeMetadata?: TypeMetadata;
     /**
      * Minimum permitted number of items in an array field.
@@ -811,6 +829,7 @@ interface _Array {
     defaultValue?: any[];
 }
 interface PageLink {
+    /** Calculation pattern used to generate the page link. Required for page link fields. */
     calculator?: Calculator;
     /**
      * Defines reference to router pattern in the site document.
@@ -825,6 +844,7 @@ interface PageLink {
 }
 interface Slug {
     /**
+     * Pattern used to generate the field value from item properties.
      * @minLength 1
      * @maxLength 1000
      */
@@ -843,16 +863,21 @@ interface Slug {
     defaultValue?: string | null;
 }
 interface Text extends TextValidationOneOf {
+    /** Length and pattern constraints for the text value. */
     textValidation?: TextValidation;
+    /** Allowed text values. */
     enumValues?: EnumValues;
     defaultValue?: string | null;
 }
 /** @oneof */
 interface TextValidationOneOf {
+    /** Length and pattern constraints for the text value. */
     textValidation?: TextValidation;
+    /** Allowed text values. */
     enumValues?: EnumValues;
 }
 interface _Number {
+    /** Value assigned when a data item omits this field. */
     defaultValue?: number | null;
     /** Minimum permitted value for a numerical field. */
     min?: number | null;
@@ -860,48 +885,68 @@ interface _Number {
     max?: number | null;
 }
 interface _Date extends _DateDefaultValueOneOf, _DateMinDateOneOf, _DateMaxDateOneOf {
+    /** Fixed date and time used as the default value. */
     defaultValueFixed?: Date | null;
+    /** Offset from the current date, in days, used as the default value. */
     defaultValueOffsetFromNowInDays?: number | null;
+    /** Earliest permitted date and time. */
     minDateFixed?: Date | null;
+    /** Offset from the current date, in days, used as the earliest permitted date. */
     minValueOffsetFromNowInDays?: number | null;
+    /** Latest permitted date and time. */
     maxDateFixed?: Date | null;
+    /** Offset from the current date, in days, used as the latest permitted date. */
     maxValueOffsetFromNowInDays?: number | null;
 }
 /** @oneof */
 interface _DateDefaultValueOneOf {
+    /** Fixed date and time used as the default value. */
     defaultValueFixed?: Date | null;
+    /** Offset from the current date, in days, used as the default value. */
     defaultValueOffsetFromNowInDays?: number | null;
 }
 /** @oneof */
 interface _DateMinDateOneOf {
+    /** Earliest permitted date and time. */
     minDateFixed?: Date | null;
+    /** Offset from the current date, in days, used as the earliest permitted date. */
     minValueOffsetFromNowInDays?: number | null;
 }
 /** @oneof */
 interface _DateMaxDateOneOf {
+    /** Latest permitted date and time. */
     maxDateFixed?: Date | null;
+    /** Offset from the current date, in days, used as the latest permitted date. */
     maxValueOffsetFromNowInDays?: number | null;
 }
 interface Datetime extends DatetimeDefaultValueOneOf, DatetimeMinDateOneOf, DatetimeMaxDateOneOf {
+    /** Fixed date and time used as the default value. */
     defaultValueFixed?: Date | null;
+    /** Offset from the current time, in seconds, used as the default value. */
     defaultValueOffsetFromNowInSeconds?: number | null;
+    /** Earliest permitted date and time. */
     minDateFixed?: Date | null;
     minDateOffsetFromNowInSeconds?: number | null;
+    /** Latest permitted date and time. */
     maxDateFixed?: Date | null;
     maxDateOffsetFromNowInSeconds?: number | null;
 }
 /** @oneof */
 interface DatetimeDefaultValueOneOf {
+    /** Fixed date and time used as the default value. */
     defaultValueFixed?: Date | null;
+    /** Offset from the current time, in seconds, used as the default value. */
     defaultValueOffsetFromNowInSeconds?: number | null;
 }
 /** @oneof */
 interface DatetimeMinDateOneOf {
+    /** Earliest permitted date and time. */
     minDateFixed?: Date | null;
     minDateOffsetFromNowInSeconds?: number | null;
 }
 /** @oneof */
 interface DatetimeMaxDateOneOf {
+    /** Latest permitted date and time. */
     maxDateFixed?: Date | null;
     maxDateOffsetFromNowInSeconds?: number | null;
 }
@@ -909,6 +954,7 @@ interface Image {
     defaultValue?: string | null;
 }
 interface _Boolean {
+    /** Value assigned when a data item omits this field. */
     defaultValue?: boolean | null;
 }
 interface Document {
@@ -916,10 +962,12 @@ interface Document {
 }
 interface Url {
     /**
+     * Value assigned when a data item omits this field.
      * @minLength 1
      * @maxLength 2048
      */
     defaultValue?: string | null;
+    /** Length and pattern constraints for the text value. */
     textValidation?: TextValidation;
 }
 interface RichText {
@@ -976,16 +1024,21 @@ interface Time {
     maxTime?: string | null;
 }
 interface RichContent {
+    /** Value assigned when a data item omits this field. */
     defaultValue?: Record<string, any> | null;
 }
 interface MediaGallery {
     defaultValue?: Record<string, any>[] | null;
 }
 interface Address {
+    /** Value assigned when a data item omits this field. */
     defaultValue?: Record<string, any> | null;
 }
 interface Email {
-    /** @format EMAIL */
+    /**
+     * Value assigned when a data item omits this field.
+     * @format EMAIL
+     */
     defaultValue?: string | null;
 }
 interface LegacyColor {
@@ -1037,12 +1090,13 @@ interface ArraySizeRange {
      */
     maxSize?: number | null;
 }
-/** Optional plug-in aspects for fields */
+/** Plugins that extend a field's behavior. */
 interface FieldPlugin extends FieldPluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: CmsOptions;
     /** Options for the CATEGORY_FIELD plugin. */
     categoryFieldOptions?: CategoryFieldOptions;
+    /** Field plugin type. */
     type?: FieldPluginTypeWithLiterals;
 }
 /** @oneof */
@@ -1053,9 +1107,9 @@ interface FieldPluginOptionsOneOf {
     categoryFieldOptions?: CategoryFieldOptions;
 }
 declare enum FieldPluginType {
-    /** Uknown plugin type. */
+    /** Unknown plugin type. */
     UNKNOWN = "UNKNOWN",
-    /** CMS-related field attributes */
+    /** CMS-related field attributes. */
     CMS = "CMS",
     /**
      * Marks a multi-reference field as a category field linking to a Category Group.
@@ -1100,7 +1154,7 @@ interface CategoryFieldOptions {
 }
 interface FieldCondition {
     /**
-     * If `group_name` is set, this field will not be present in query results. To retrieve this field, pass `group_name` value to `includeFieldGroups` parameter in query operations.
+     * If `groupName` is set, this field will not be present in query results. To retrieve this field, pass `groupName` value to `includeFieldGroups` parameter in query operations.
      * @maxLength 100
      */
     groupName?: string | null;
@@ -1213,7 +1267,9 @@ interface PluginOptionsOneOf {
     draftItemsOptions?: DraftItemsPluginOptions;
 }
 declare enum Status {
+    /** Items are published by default. */
     PUBLISHED = "PUBLISHED",
+    /** Items are drafts by default. */
     DRAFT = "DRAFT"
 }
 /** @enumType */
@@ -1327,7 +1383,11 @@ declare enum PluginType {
 /** @enumType */
 type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
 interface PublishPluginOptions {
-    /** Default status. */
+    /**
+     * Publication status assigned to items that don't specify one.
+     *
+     * Default: `PUBLISHED`.
+     */
     defaultStatus?: StatusWithLiterals;
     /**
      * Server-managed lifecycle status.
@@ -1344,7 +1404,11 @@ interface SingleItemPluginOptions {
     singleItemId?: string;
 }
 interface UrlizedPluginOptions {
-    /** Encoding method for generating a URL in ASCII characters. */
+    /**
+     * Encoding method for generating a URL in ASCII characters.
+     *
+     * Default: `ORIGINAL`.
+     */
     format?: FormatWithLiterals;
 }
 interface MultilingualOptions {
@@ -1356,7 +1420,17 @@ interface MultilingualOptions {
     translatableFieldKeys?: string[];
 }
 interface PageLinkPluginOptions {
+    /**
+     * Whether page link values are stored with the items.
+     *
+     * Default: `false`.
+     */
     isPersisted?: boolean;
+    /**
+     * Whether page link values can be updated.
+     *
+     * Default: `false`.
+     */
     isMutable?: boolean;
 }
 interface PluginCmsOptions {
@@ -1508,10 +1582,13 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
      * @readonly
      */
     publishedCollectionId?: string;
-    /** @internal */
+    /**
+     * Access levels required to view and manage drafts and change publication status.
+     * @internal
+     */
     draftPermissions?: DraftPermissions;
     /**
-     * Actual draft management operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`.
+     * Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
      * @internal
      * @readonly
      */
@@ -1607,32 +1684,32 @@ interface DataCollectionClonedEvent {
 }
 interface DataCollectionChangedEvent {
     /**
-     * list of new fields
+     * Fields added to the collection.
      * @maxSize 1000
      */
     fieldsAdded?: Field[];
     /**
-     * list of changed fields
+     * Fields whose definitions changed.
      * @maxSize 1000
      */
     fieldsUpdated?: FieldUpdate[];
     /**
-     * list of removed fields
+     * Fields removed from the collection.
      * @maxSize 1000
      */
     fieldsRemoved?: Field[];
     /**
-     * list of new plugins
+     * Plugins added to the collection.
      * @maxSize 100
      */
     pluginsAdded?: Plugin[];
     /**
-     * list of changed plugins
+     * Plugins whose options changed.
      * @maxSize 100
      */
     pluginsUpdated?: PluginUpdate[];
     /**
-     * list of removed plugins
+     * Plugins removed from the collection.
      * @maxSize 100
      */
     pluginsRemoved?: Plugin[];
@@ -1642,15 +1719,15 @@ interface DataCollectionChangedEvent {
     strictModeUpdated?: StrictModeUpdate;
 }
 interface FieldUpdate {
-    /** previous state of the field */
+    /** Previous field definition. */
     previous?: Field;
-    /** current state of the field */
+    /** Updated field definition. */
     current?: Field;
 }
 interface PluginUpdate {
-    /** previous state of the plugin */
+    /** Previous plugin configuration. */
     previous?: Plugin;
-    /** current state of the plugin */
+    /** Updated plugin configuration. */
     current?: Plugin;
 }
 interface PermissionsUpdate {
@@ -1678,7 +1755,7 @@ interface CreateDataCollectionRequest {
     collection: DataCollection;
 }
 interface CreateDataCollectionResponse {
-    /** Details of collection created. */
+    /** Created collection. */
     collection?: DataCollection;
 }
 interface GetDataCollectionRequest {
@@ -1721,8 +1798,9 @@ interface GetDataCollectionRequest {
      */
     segment?: SegmentWithLiterals;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 1000
      */
@@ -1736,7 +1814,7 @@ declare enum Segment {
 /** @enumType */
 type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
 interface GetDataCollectionResponse {
-    /** Details of the collection requested. */
+    /** Requested collection. */
     collection?: DataCollection;
     /**
      * Details of collections referenced by the collection requested.
@@ -1749,10 +1827,16 @@ interface ListDataCollectionsRequest {
     /**
      * Defines how collections in the response are sorted.
      *
-     * Default: Ordered by ID in ascending order.
+     * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
+     *
+     * Default: `id` in ascending order.
      */
     sort?: Sorting;
-    /** Pagination information. */
+    /**
+     * Pagination information. The maximum page size is `1000`.
+     *
+     * Default: `limit` is `1000` and `offset` is `0`.
+     */
     paging?: Paging;
     /**
      * Whether to retrieve data from the primary database instance.
@@ -1774,8 +1858,9 @@ interface ListDataCollectionsRequest {
      */
     segment?: SegmentWithLiterals;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 128
      */
@@ -1846,7 +1931,13 @@ interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     includeReferencedCollections?: boolean;
-    /** Sorting preferences. */
+    /**
+     * Sorting preferences for active and deleted collections. Results aren't returned in request order.
+     *
+     * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
+     *
+     * Default: `id` in ascending order.
+     */
     sort?: Sorting;
     /**
      * Whether to retrieve data from the primary database instance.
@@ -1868,8 +1959,9 @@ interface BulkGetDataCollectionsRequest {
      */
     segment?: SegmentWithLiterals;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 1000
      */
@@ -1878,12 +1970,12 @@ interface BulkGetDataCollectionsRequest {
 interface BulkGetDataCollectionsResponse {
     /**
      * List of requested collections.
-     * When `include_referenced_collections` is `true` in the request, referenced collections are included here.
+     * When `includeReferencedCollections` is `true` in the request, referenced collections are included here.
      */
     activeCollections?: DataCollection[];
     /** List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request. */
     deletedCollections?: DataCollection[];
-    /** List of failed collections. */
+    /** Collections that couldn't be loaded, with an error for each failure. */
     failedCollections?: FailedCollection[];
 }
 interface ApplicationError {
@@ -1896,7 +1988,7 @@ interface ApplicationError {
 }
 interface FailedCollection {
     /**
-     * IDs of the failed collection.
+     * ID of the collection that couldn't be loaded.
      * @maxLength 255
      */
     collectionId?: string;
@@ -1922,13 +2014,13 @@ interface DeleteDataCollectionResponse {
 }
 interface RestoreDataCollectionRequest {
     /**
-     * Data Collection ID to restore
+     * ID of the data collection to restore.
      * @maxLength 256
      */
     dataCollectionId?: string;
 }
 interface RestoreDataCollectionResponse {
-    /** Restored data collection */
+    /** Restored data collection. */
     dataCollection?: DataCollection;
 }
 interface PatchDataCollectionRequest {
@@ -2028,7 +2120,11 @@ interface AddPublishPluginRequest {
     dataCollectionId: string;
     /** Publish plugin options. */
     publishOptions: PublishPluginOptions;
-    /** Action to take when the Draft Items plugin is already installed. */
+    /**
+     * Action to take when the Draft Items plugin is already installed.
+     *
+     * Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
+     */
     draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
 }
 /** Behavior to apply when adding the Publish plugin to a collection that already has the Draft Items plugin. */
@@ -2065,7 +2161,10 @@ interface UpdatePublishPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated Publish plugin options. Read-only fields are ignored. */
+    /**
+     * Replacement writable options for the Publish plugin. Omitted options use their defaults.
+     * Server-managed lifecycle status is preserved.
+     */
     publishOptions: PublishPluginOptions;
 }
 interface UpdatePublishPluginResponse {
@@ -2102,7 +2201,7 @@ interface UpdateUrlizedPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated Urlized plugin options. */
+    /** Replacement options for the Urlized plugin. Omitted options use their defaults. */
     urlizedOptions: UrlizedPluginOptions;
 }
 interface UpdateUrlizedPluginResponse {
@@ -2139,7 +2238,7 @@ interface UpdateMultilingualPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated Multilingual plugin options. */
+    /** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
     multilingualOptions: MultilingualOptions;
 }
 interface UpdateMultilingualPluginResponse {
@@ -2176,7 +2275,7 @@ interface UpdateCmsPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated CMS plugin options. */
+    /** Replacement options for the CMS plugin. Omitted options use their defaults. */
     cmsOptions: PluginCmsOptions;
 }
 interface UpdateCmsPluginResponse {
@@ -2213,7 +2312,7 @@ interface UpdateCatalogPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated Catalog plugin options. */
+    /** Replacement options for the Catalog plugin. Omitted options use their defaults. */
     catalogOptions: CatalogOptions;
 }
 interface UpdateCatalogPluginResponse {
@@ -2228,7 +2327,11 @@ interface AddDraftItemsPluginRequest {
     dataCollectionId: string;
     /** Draft Items plugin options. */
     draftItemsOptions: DraftItemsPluginOptions;
-    /** Action to take when the Publish plugin is already installed. */
+    /**
+     * Action to take when the Publish plugin is already installed.
+     *
+     * Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
+     */
     publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
 }
 /** Behavior to apply when adding the Draft Items plugin to a collection that already has the Publish plugin. */
@@ -2250,7 +2353,11 @@ interface DeleteDraftItemsPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Action to take for existing draft items. */
+    /**
+     * Action to take for existing draft items.
+     *
+     * Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
+     */
     draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
 }
 /** Behavior to apply to existing draft items when removing the Draft Items plugin. */
@@ -2274,7 +2381,10 @@ interface UpdateDraftItemsPluginRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Updated Draft Items plugin options. Read-only fields are ignored. */
+    /**
+     * Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
+     * Server-managed paired collection IDs are preserved.
+     */
     draftItemsOptions: DraftItemsPluginOptions;
 }
 interface UpdateDraftItemsPluginResponse {
@@ -2287,12 +2397,13 @@ interface PatchDataCollectionFieldRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Field to update. */
+    /** Field to update. Specify `key` to identify the existing field. */
     field: Field;
     /**
      * Field mask specifying which field properties to update.
      * Supported properties: `displayName`, `type`, `typeMetadata`, `encrypted`, `description`.
      * Attempting to update `key` or other unsupported properties results in an error.
+     * Each masked property must have a value in `field`. To set `encrypted` to `false`, explicitly include it in the mask.
      * @internal
      */
     fieldMask?: string[];
@@ -2315,6 +2426,7 @@ interface UpdateDataPermissionsResponse {
     dataCollection?: DataCollection;
 }
 interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
+    /** App whose collection snapshots to retrieve. */
     appOptions?: AppOptions;
     /**
      * Ids of schema snapshot
@@ -2333,6 +2445,7 @@ interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollec
 }
 /** @oneof */
 interface BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
+    /** App whose collection snapshots to retrieve. */
     appOptions?: AppOptions;
 }
 declare enum TenantMode {
@@ -2620,15 +2733,27 @@ interface DeleteDataCollectionsSnapshotRequest {
 interface DeleteDataCollectionsSnapshotResponse {
 }
 interface CreateMigratedCollectionsSnapshotRequest {
-    /** @format GUID */
+    /**
+     * ID of the source snapshot.
+     * @format GUID
+     */
     existingSnapshotId?: string;
-    /** @maxLength 255 */
+    /**
+     * Namespace to assign to collections in the new snapshot.
+     * @maxLength 255
+     */
     newNamespace?: string;
-    /** @maxLength 255 */
+    /**
+     * Namespace to replace in the source snapshot.
+     * @maxLength 255
+     */
     existingNamespace?: string;
 }
 interface CreateMigratedCollectionsSnapshotResponse {
-    /** @format GUID */
+    /**
+     * ID of the created snapshot.
+     * @format GUID
+     */
     snapshotId?: string;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -2785,7 +2910,7 @@ interface AccountInfo {
     siteId?: string | null;
 }
 /**
- * Creates a new data collection.
+ * Creates a data collection.
  *
  * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
  * @param collection - Collection details.
@@ -2801,25 +2926,26 @@ interface AccountInfo {
  * @param options - Options for creating a data collection.
  * @permissionId WIX_DATA.CREATE_COLLECTION
  * @applicableIdentity APP
- * @returns Details of collection created.
+ * @returns Created collection.
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
  */
 declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
 /**
  * Retrieves a data collection by ID.
  *
- * Starting on August 3rd, 2026, when called with a visitor (unauthenticated) identity, the response contains only
- * the collection details needed to display the collection's data: `id`, `displayName`, `displayField`, `plugins`,
- * and for each field in `fields` its `key`, `displayName`, `type`, and `typeMetadata`. All other collection
- * details, such as `permissions` and `capabilities`, are omitted. Calls made with any other identity return the
- * full collection.
+ * Calls made with a visitor (unauthenticated) identity return a limited collection view.
+ * The response includes display information, plugins, paging information, and supported operations.
+ * It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
+ * Other identities return the full collection, subject to the requested field selection.
+ *
+ * To retrieve multiple collections in one call, use [Bulk Get Data Collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/bulk-get-data-collections).
  * @param dataCollectionId - ID of the collection to retrieve.
  * @public
  * @requiredField dataCollectionId
  * @param options - Options for retrieving a data collection.
  * @permissionId WIX_DATA.GET_COLLECTION
  * @applicableIdentity APP
- * @returns Details of the collection requested.
+ * @returns Requested collection.
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
  */
 declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
@@ -2838,17 +2964,20 @@ interface GetDataCollectionOptions {
      */
     includeAllowedDataPermissions?: boolean;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 1000
      */
     fields?: string[];
 }
 /**
- * Retrieves a list of all data collections associated with the site or project.
+ * Retrieves a page of data collections associated with the site or project.
  *
- * By default, the list is ordered by ID in ascending order.
+ * By default, results are sorted by `id` in ascending order, `paging.limit` is `1000`, and `paging.offset` is `0`.
+ * The maximum page size is `1000`. Larger limits are reduced to `1000`.
+ * To retrieve the next page, increase `paging.offset` by the number of collections returned.
  * @public
  * @param options - Options for retrieving a list of data collections.
  * @permissionId WIX_DATA.LIST_COLLECTIONS
@@ -2860,10 +2989,16 @@ interface ListDataCollectionsOptions {
     /**
      * Defines how collections in the response are sorted.
      *
-     * Default: Ordered by ID in ascending order.
+     * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
+     *
+     * Default: `id` in ascending order.
      */
     sort?: Sorting;
-    /** Pagination information. */
+    /**
+     * Pagination information. The maximum page size is `1000`.
+     *
+     * Default: `limit` is `1000` and `offset` is `0`.
+     */
     paging?: Paging;
     /**
      * Whether to retrieve data from the primary database instance.
@@ -2879,8 +3014,9 @@ interface ListDataCollectionsOptions {
      */
     includeAllowedDataPermissions?: boolean;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 128
      */
@@ -2889,11 +3025,16 @@ interface ListDataCollectionsOptions {
 /**
  * Retrieves multiple data collections by ID.
  *
- * Starting on August 3rd, 2026, when called with a visitor (unauthenticated) identity, the returned collections
- * contain only the details needed to display the collections' data: `id`, `displayName`, `displayField`,
- * `plugins`, and for each field in `fields` its `key`, `displayName`, `type`, and `typeMetadata`. All other
- * collection details, such as `permissions` and `capabilities`, are omitted. Calls made with any other identity
- * return the full collections.
+ * Calls made with a visitor (unauthenticated) identity return a limited collection view.
+ * The response includes display information, plugins, paging information, and supported operations.
+ * It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
+ * Other identities return the full collection, subject to the requested field selection.
+ *
+ * Successful results are returned in `activeCollections` and, when requested, `deletedCollections`.
+ * Collection loading failures are returned separately in `failedCollections`.
+ * Results are sorted by `id` in ascending order unless `sort` specifies a different order.
+ *
+ * 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).
  * @public
  * @documentationMaturity preview
  * @permissionId WIX_DATA.BULK_GET_COLLECTIONS
@@ -2921,7 +3062,13 @@ interface BulkGetDataCollectionsOptions {
      * Default: `false`
      */
     includeReferencedCollections?: boolean;
-    /** Sorting preferences. */
+    /**
+     * Sorting preferences for active and deleted collections. Results aren't returned in request order.
+     *
+     * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
+     *
+     * Default: `id` in ascending order.
+     */
     sort?: Sorting;
     /**
      * Whether to retrieve data from the primary database instance.
@@ -2937,8 +3084,9 @@ interface BulkGetDataCollectionsOptions {
      */
     includeAllowedDataPermissions?: boolean;
     /**
-     * List of specific field names to return, if empty all fields are returned.
-     * Affects all returned collections
+     * Top-level collection properties to return, using camelCase names, such as `displayName`.
+     * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
+     * An empty list returns all properties available to the caller.
      * @maxSize 100
      * @maxLength 1000
      */
@@ -2988,7 +3136,7 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
  *
  * Before deleting a collection:
  * - Make sure the collection isn't connected to any site pages or elements.
- * - You can create a manual backup of a collections with the Backups API, in case you need to restore them later.
+ * - You can create a manual backup of collections with the Backups API, in case you need to restore them later.
  * - You can also export a collection to a CSV file with the Data Movement Jobs API, if you want to save the data outside of Wix.
  *
  * > **Note:**
@@ -3002,10 +3150,10 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
  */
 declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
 /**
- * Restores recently deleted collection.
+ * Restores a recently deleted data collection.
  *
  * Fails with `WDE0025` if collection was deleted too long ago or has never existed.
- * @param dataCollectionId - Data Collection ID to restore
+ * @param dataCollectionId - ID of the data collection to restore.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3062,6 +3210,8 @@ interface PatchDataCollection {
     maxPageSize?: number | null;
     /**
      * Collection's display name as shown in the CMS. For example, `My First Collection`.
+     *
+     * Default: The collection ID.
      * @maxLength 1000
      */
     displayName?: string | null;
@@ -3079,6 +3229,8 @@ interface PatchDataCollection {
     displayNamespace?: string | null;
     /**
      * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
+     *
+     * Default: The first field in the request, or `title` if no fields are specified.
      * @maxLength 1000
      */
     displayField?: string | null;
@@ -3127,7 +3279,7 @@ interface PatchDataCollection {
      */
     dataPermissions?: DataPermissions;
     /**
-     * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
+     * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
      * @internal
      * @readonly
      */
@@ -3169,13 +3321,13 @@ interface CreateDataCollectionFieldOptions {
     field: Field;
 }
 /**
- * Updates properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
+ * Replaces the definition of a field in a data collection.
  *
  * <blockquote class="important">
  * <strong>Important:</strong>
  *
- * After `fields` is updated, it only contains the properties included in the Update Data Collection Field request.
- * If the existing `fields` array has properties with values and those properties aren't included in the updated details, their values are lost.<br/><br/>
+ * The field identified by `field.key` is replaced with the supplied definition.
+ * Properties omitted from that field definition aren't preserved. Other fields in the collection aren't replaced.<br/><br/>
  *
  * To update only specific properties in the array without affecting others, use [Patch Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection-field).
  * </blockquote>
@@ -3259,6 +3411,8 @@ interface DeleteDataCollectionPluginOptions {
 }
 /**
  * Adds the Publish plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3274,11 +3428,17 @@ declare function addPublishPlugin(dataCollectionId: string, options?: NonNullabl
 interface AddPublishPluginOptions {
     /** Publish plugin options. */
     publishOptions: PublishPluginOptions;
-    /** Action to take when the Draft Items plugin is already installed. */
+    /**
+     * Action to take when the Draft Items plugin is already installed.
+     *
+     * Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
+     */
     draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
 }
 /**
  * Removes the Publish plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3290,6 +3450,9 @@ interface AddPublishPluginOptions {
 declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 /**
  * Updates the Publish plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3302,11 +3465,16 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
  */
 declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdatePublishPluginOptions {
-    /** Updated Publish plugin options. Read-only fields are ignored. */
+    /**
+     * Replacement writable options for the Publish plugin. Omitted options use their defaults.
+     * Server-managed lifecycle status is preserved.
+     */
     publishOptions: PublishPluginOptions;
 }
 /**
  * Adds the Urlized plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3325,6 +3493,8 @@ interface AddUrlizedPluginOptions {
 }
 /**
  * Removes the Urlized plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3336,6 +3506,9 @@ interface AddUrlizedPluginOptions {
 declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 /**
  * Updates the Urlized plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3348,11 +3521,13 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
  */
 declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdateUrlizedPluginOptions {
-    /** Updated Urlized plugin options. */
+    /** Replacement options for the Urlized plugin. Omitted options use their defaults. */
     urlizedOptions: UrlizedPluginOptions;
 }
 /**
  * Adds the Multilingual plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3371,6 +3546,8 @@ interface AddMultilingualPluginOptions {
 }
 /**
  * Removes the Multilingual plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3382,6 +3559,9 @@ interface AddMultilingualPluginOptions {
 declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 /**
  * Updates the Multilingual plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3394,11 +3574,13 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
  */
 declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdateMultilingualPluginOptions {
-    /** Updated Multilingual plugin options. */
+    /** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
     multilingualOptions: MultilingualOptions;
 }
 /**
  * Adds the CMS plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3417,6 +3599,8 @@ interface AddCmsPluginOptions {
 }
 /**
  * Removes the CMS plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3428,6 +3612,9 @@ interface AddCmsPluginOptions {
 declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 /**
  * Updates the CMS plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3440,11 +3627,13 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
  */
 declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdateCmsPluginOptions {
-    /** Updated CMS plugin options. */
+    /** Replacement options for the CMS plugin. Omitted options use their defaults. */
     cmsOptions: PluginCmsOptions;
 }
 /**
  * Adds the Catalog plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3463,6 +3652,8 @@ interface AddCatalogPluginOptions {
 }
 /**
  * Removes the Catalog plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3474,6 +3665,9 @@ interface AddCatalogPluginOptions {
 declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 /**
  * Updates the Catalog plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3486,11 +3680,13 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
  */
 declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdateCatalogPluginOptions {
-    /** Updated Catalog plugin options. */
+    /** Replacement options for the Catalog plugin. Omitted options use their defaults. */
     catalogOptions: CatalogOptions;
 }
 /**
  * Adds the Draft Items plugin to a data collection.
+ *
+ * Fails if the collection already has this plugin.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -3506,11 +3702,17 @@ declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNull
 interface AddDraftItemsPluginOptions {
     /** Draft Items plugin options. */
     draftItemsOptions: DraftItemsPluginOptions;
-    /** Action to take when the Publish plugin is already installed. */
+    /**
+     * Action to take when the Publish plugin is already installed.
+     *
+     * Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
+     */
     publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
 }
 /**
  * Removes the Draft Items plugin from a data collection.
+ *
+ * Fails if the collection doesn't have this plugin.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3522,11 +3724,18 @@ interface AddDraftItemsPluginOptions {
  */
 declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface DeleteDraftItemsPluginOptions {
-    /** Action to take for existing draft items. */
+    /**
+     * Action to take for existing draft items.
+     *
+     * Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
+     */
     draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
 }
 /**
  * Updates the Draft Items plugin options on a data collection.
+ *
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
+ * Server-managed properties are preserved, and other plugins aren't changed.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -3539,17 +3748,20 @@ interface DeleteDraftItemsPluginOptions {
  */
 declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
 interface UpdateDraftItemsPluginOptions {
-    /** Updated Draft Items plugin options. Read-only fields are ignored. */
+    /**
+     * Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
+     * Server-managed paired collection IDs are preserved.
+     */
     draftItemsOptions: DraftItemsPluginOptions;
 }
 /**
- * Updates specified properties  in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
+ * Updates specified properties of a field in a data collection.
  *
  * When you change a field's type, existing values aren't migrated. Use [Bulk Update Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-update-data-items) or [Bulk Patch Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-patch-data-items) to update item values to match the new type.
  *
  * To update properties in a data collection other than `fields`, use [Patch Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection).
  * @param dataCollectionId - ID of the data collection to update.
- * @param field - Field to update.
+ * @param field - Field to update. Specify `key` to identify the existing field.
  * @public
  * @requiredField dataCollectionId
  * @requiredField field