@wix/auto_sdk_data_collections 1.0.108 → 1.0.110

package/build/internal/cjs/meta.d.ts

@@ -1,7 +1,10 @@
 import { CreateDataCollectionRequest as CreateDataCollectionRequest$1, CreateDataCollectionResponse as CreateDataCollectionResponse$1, GetDataCollectionRequest as GetDataCollectionRequest$1, GetDataCollectionResponse as GetDataCollectionResponse$1, ListDataCollectionsRequest as ListDataCollectionsRequest$1, ListDataCollectionsResponse as ListDataCollectionsResponse$1, BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest$1, BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse$1, UpdateDataCollectionRequest as UpdateDataCollectionRequest$1, UpdateDataCollectionResponse as UpdateDataCollectionResponse$1, DeleteDataCollectionRequest as DeleteDataCollectionRequest$1, DeleteDataCollectionResponse as DeleteDataCollectionResponse$1, RestoreDataCollectionRequest as RestoreDataCollectionRequest$1, RestoreDataCollectionResponse as RestoreDataCollectionResponse$1, PatchDataCollectionRequest as PatchDataCollectionRequest$1, PatchDataCollectionResponse as PatchDataCollectionResponse$1, CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest$1, CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse$1, UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest$1, UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse$1, DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest$1, DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse$1, AddDataCollectionPluginRequest as AddDataCollectionPluginRequest$1, AddDataCollectionPluginResponse as AddDataCollectionPluginResponse$1, DeleteDataCollectionPluginRequest as DeleteDataCollectionPluginRequest$1, DeleteDataCollectionPluginResponse as DeleteDataCollectionPluginResponse$1, AddPublishPluginRequest as AddPublishPluginRequest$1, AddPublishPluginResponse as AddPublishPluginResponse$1, DeletePublishPluginRequest as DeletePublishPluginRequest$1, DeletePublishPluginResponse as DeletePublishPluginResponse$1, UpdatePublishPluginRequest as UpdatePublishPluginRequest$1, UpdatePublishPluginResponse as UpdatePublishPluginResponse$1, AddUrlizedPluginRequest as AddUrlizedPluginRequest$1, AddUrlizedPluginResponse as AddUrlizedPluginResponse$1, DeleteUrlizedPluginRequest as DeleteUrlizedPluginRequest$1, DeleteUrlizedPluginResponse as DeleteUrlizedPluginResponse$1, UpdateUrlizedPluginRequest as UpdateUrlizedPluginRequest$1, UpdateUrlizedPluginResponse as UpdateUrlizedPluginResponse$1, AddMultilingualPluginRequest as AddMultilingualPluginRequest$1, AddMultilingualPluginResponse as AddMultilingualPluginResponse$1, DeleteMultilingualPluginRequest as DeleteMultilingualPluginRequest$1, DeleteMultilingualPluginResponse as DeleteMultilingualPluginResponse$1, UpdateMultilingualPluginRequest as UpdateMultilingualPluginRequest$1, UpdateMultilingualPluginResponse as UpdateMultilingualPluginResponse$1, AddCmsPluginRequest as AddCmsPluginRequest$1, AddCmsPluginResponse as AddCmsPluginResponse$1, DeleteCmsPluginRequest as DeleteCmsPluginRequest$1, DeleteCmsPluginResponse as DeleteCmsPluginResponse$1, UpdateCmsPluginRequest as UpdateCmsPluginRequest$1, UpdateCmsPluginResponse as UpdateCmsPluginResponse$1, AddCatalogPluginRequest as AddCatalogPluginRequest$1, AddCatalogPluginResponse as AddCatalogPluginResponse$1, DeleteCatalogPluginRequest as DeleteCatalogPluginRequest$1, DeleteCatalogPluginResponse as DeleteCatalogPluginResponse$1, UpdateCatalogPluginRequest as UpdateCatalogPluginRequest$1, UpdateCatalogPluginResponse as UpdateCatalogPluginResponse$1, AddDraftItemsPluginRequest as AddDraftItemsPluginRequest$1, AddDraftItemsPluginResponse as AddDraftItemsPluginResponse$1, DeleteDraftItemsPluginRequest as DeleteDraftItemsPluginRequest$1, DeleteDraftItemsPluginResponse as DeleteDraftItemsPluginResponse$1, UpdateDraftItemsPluginRequest as UpdateDraftItemsPluginRequest$1, UpdateDraftItemsPluginResponse as UpdateDraftItemsPluginResponse$1, PatchDataCollectionFieldRequest as PatchDataCollectionFieldRequest$1, PatchDataCollectionFieldResponse as PatchDataCollectionFieldResponse$1 } from './index.typings.js';
 import '@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`.
@@ -31,6 +34,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;
@@ -48,6 +53,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;
@@ -96,7 +103,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
      */
@@ -248,7 +255,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.
@@ -268,6 +275,7 @@ interface Field extends FieldRangeValidationsOneOf {
      */
     description?: string | null;
     /**
+     * Plugin that manages this field.
      * @internal
      * @maxLength 100
      */
@@ -279,7 +287,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`
      */
@@ -302,7 +310,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;
@@ -711,7 +719,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.
@@ -720,12 +728,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 {
@@ -790,13 +805,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.
@@ -812,6 +830,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.
@@ -826,6 +845,7 @@ interface PageLink {
 }
 interface Slug {
     /**
+     * Pattern used to generate the field value from item properties.
      * @minLength 1
      * @maxLength 1000
      */
@@ -844,16 +864,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;
@@ -861,48 +886,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;
 }
@@ -910,6 +955,7 @@ interface Image {
     defaultValue?: string | null;
 }
 interface _Boolean {
+    /** Value assigned when a data item omits this field. */
     defaultValue?: boolean | null;
 }
 interface Document {
@@ -917,10 +963,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 {
@@ -977,16 +1025,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 {
@@ -1038,12 +1091,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 */
@@ -1054,9 +1108,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.
@@ -1101,7 +1155,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;
@@ -1214,7 +1268,9 @@ interface PluginOptionsOneOf {
     draftItemsOptions?: DraftItemsPluginOptions;
 }
 declare enum Status {
+    /** Items are published by default. */
     PUBLISHED = "PUBLISHED",
+    /** Items are drafts by default. */
     DRAFT = "DRAFT"
 }
 /** @enumType */
@@ -1328,7 +1384,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.
@@ -1345,7 +1405,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 {
@@ -1357,7 +1421,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 {
@@ -1366,7 +1440,9 @@ interface PluginCmsOptions {
 }
 interface CatalogOptions {
     /**
-     * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
+     *
+     * Use `nameFieldKey` instead. If both properties are specified, a non-empty `nameFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy name_field_key
@@ -1374,7 +1450,9 @@ interface CatalogOptions {
      */
     name?: string;
     /**
-     * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
+     *
+     * Use `priceFieldKey` instead. If both properties are specified, a non-empty `priceFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy price_field_key
@@ -1382,7 +1460,9 @@ interface CatalogOptions {
      */
     price?: string;
     /**
-     * the field key that contains the catalog item URL - field must be of type URL.
+     * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
+     *
+     * Use `urlFieldKey` instead. If both properties are specified, a non-empty `urlFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy url_field_key
@@ -1390,7 +1470,9 @@ interface CatalogOptions {
      */
     url?: string | null;
     /**
-     * the field key that contains the catalog item description - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
+     *
+     * Use `descriptionFieldKey` instead. If both properties are specified, a non-empty `descriptionFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy description_field_key
@@ -1398,7 +1480,9 @@ interface CatalogOptions {
      */
     description?: string | null;
     /**
-     * the field key that contains the catalog item image - field must be of type IMAGE.
+     * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
+     *
+     * Use `imageFieldKey` instead. If both properties are specified, a non-empty `imageFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy image_field_key
@@ -1406,7 +1490,9 @@ interface CatalogOptions {
      */
     image?: string | null;
     /**
-     * the field key that contains the catalog item quantity - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
+     *
+     * Use `quantityFieldKey` instead. If both properties are specified, a non-empty `quantityFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy quantity_field_key
@@ -1414,7 +1500,9 @@ interface CatalogOptions {
      */
     quantity?: string | null;
     /**
-     * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
+     * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
+     *
+     * Use `digitalFileFieldKey` instead. If both properties are specified, a non-empty `digitalFileFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy digital_file_field_key
@@ -1422,7 +1510,9 @@ interface CatalogOptions {
      */
     digitalFile?: string | null;
     /**
-     * the field key that contains the catalog item weight - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
+     *
+     * Use `weightFieldKey` instead. If both properties are specified, a non-empty `weightFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy weight_field_key
@@ -1430,7 +1520,9 @@ interface CatalogOptions {
      */
     weight?: string | null;
     /**
-     * the field key that contains the catalog item SKU - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
+     *
+     * Use `skuFieldKey` instead. If both properties are specified, a non-empty `skuFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy sku_field_key
@@ -1438,7 +1530,9 @@ interface CatalogOptions {
      */
     sku?: string | null;
     /**
-     * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
+     * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
+     *
+     * Use `shippableFieldKey` instead. If both properties are specified, a non-empty `shippableFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy shippable_field_key
@@ -1446,52 +1540,56 @@ interface CatalogOptions {
      */
     shippable?: string | null;
     /**
-     * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
+     *
+     * Required when configuring the Catalog plugin.
      * @maxLength 1000
      */
     nameFieldKey?: string;
     /**
-     * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
+     *
+     * Required when configuring the Catalog plugin.
      * @maxLength 1000
      */
     priceFieldKey?: string;
     /**
-     * the field key that contains the catalog item URL - field must be of type URL.
+     * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
      * @maxLength 1000
      */
     urlFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item description - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
      * @maxLength 1000
      */
     descriptionFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item image - field must be of type IMAGE.
+     * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
      * @maxLength 1000
      */
     imageFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item quantity - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
      * @maxLength 1000
      */
     quantityFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
+     * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
      * @maxLength 1000
      */
     digitalFileFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item weight - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
      * @maxLength 1000
      */
     weightFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item SKU - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
      * @maxLength 1000
      */
     skuFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
+     * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
      * @maxLength 1000
      */
     shippableFieldKey?: string | null;
@@ -1509,10 +1607,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
      */
@@ -1608,32 +1709,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[];
@@ -1643,15 +1744,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 {
@@ -1679,7 +1780,7 @@ interface CreateDataCollectionRequest {
     collection: DataCollection;
 }
 interface CreateDataCollectionResponse {
-    /** Details of collection created. */
+    /** Created collection. */
     collection?: DataCollection;
 }
 interface GetDataCollectionRequest {
@@ -1722,8 +1823,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
      */
@@ -1737,7 +1839,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.
@@ -1750,10 +1852,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.
@@ -1775,8 +1883,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
      */
@@ -1847,7 +1956,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.
@@ -1869,8 +1984,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
      */
@@ -1879,12 +1995,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 {
@@ -1897,7 +2013,7 @@ interface ApplicationError {
 }
 interface FailedCollection {
     /**
-     * IDs of the failed collection.
+     * ID of the collection that couldn't be loaded.
      * @maxLength 255
      */
     collectionId?: string;
@@ -1923,13 +2039,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 {
@@ -2029,7 +2145,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. */
@@ -2066,7 +2186,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 {
@@ -2103,7 +2226,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 {
@@ -2140,7 +2263,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 {
@@ -2177,7 +2300,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 {
@@ -2214,7 +2337,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 {
@@ -2229,7 +2352,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. */
@@ -2251,7 +2378,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. */
@@ -2275,7 +2406,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 {
@@ -2288,12 +2422,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[];
@@ -2316,6 +2451,7 @@ interface UpdateDataPermissionsResponse {
     dataCollection?: DataCollection;
 }
 interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
+    /** App whose collection snapshots to retrieve. */
     appOptions?: AppOptions;
     /**
      * Ids of schema snapshot
@@ -2334,6 +2470,7 @@ interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollec
 }
 /** @oneof */
 interface BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
+    /** App whose collection snapshots to retrieve. */
     appOptions?: AppOptions;
 }
 declare enum TenantMode {
@@ -2621,15 +2758,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 {