@wix/auto_sdk_data_collections 1.0.70 → 1.0.72

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

@@ -3,7 +3,8 @@ import { NonNullablePaths } from '@wix/sdk-types';
 /** A data collection determines the structure of data to be stored in a database. */
 interface DataCollection {
     /**
-     * Collection ID. For example, `my-first-collection`. May include a namespace.
+     * [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`.
+     * For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
      * @immutable
      * @maxLength 256
      */
@@ -50,6 +51,7 @@ interface DataCollection {
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
+     * Capabilities are set by default. Values depend on the collection type.
      * @readonly
      */
     capabilities?: CollectionCapabilities;
@@ -133,7 +135,7 @@ interface CollectionCapabilities {
     /**
      * Data operations the collection supports. The listed operations can be performed on data the collection contains.
      *
-     * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
+     * > **Note**: The `PATCH` and `BULK_PATCH` operations aren't currently supported.
      * @maxSize 100
      */
     dataOperations?: DataOperationWithLiterals[];
@@ -972,7 +974,7 @@ interface CatalogOptions {
      */
     quantity?: string | null;
     /**
-     * the field key that contains the catalog item digital file
+     * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
      * @maxLength 1000
      */
     digitalFile?: string | null;
@@ -2085,11 +2087,13 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
  * Updates specified properties of a data collection.
  *
  * Only updates the properties specified in the request, all other properties remain unchanged.
- * The following properties can be updated with this method: `displayName`, `displayField`, `permissions`, `dataPermissions`. If attempting to update other, unsupported properties, this operation fails.
+ * The following properties can be updated with this method: `displayName`, `displayField`, and `permissions`.
+ * Attempting to update unsupported properties causes this operation to fail.
  *
- * To update properties in a collection's `fields`array, use [Patch Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection-field).
+ * To update properties in a collection's `fields` array, use [Patch Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection-field).
  * To add or remove `plugins`, use [Add Data Collection Plugin](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/add-data-collection-plugin) or [Delete Data Collection Plugin](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/delete-data-collection-plugin).
- * @param _id - Collection ID. For example, `my-first-collection`. May include a namespace.
+ * @param _id - [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`.
+ * For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -2101,7 +2105,8 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
 declare function patchDataCollection(_id: string, dataCollection: PatchDataCollection): Promise<NonNullablePaths<PatchDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 interface PatchDataCollection {
     /**
-     * Collection ID. For example, `my-first-collection`. May include a namespace.
+     * [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`.
+     * For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
      * @immutable
      * @maxLength 256
      */
@@ -2148,6 +2153,7 @@ interface PatchDataCollection {
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
+     * Capabilities are set by default. Values depend on the collection type.
      * @readonly
      */
     capabilities?: CollectionCapabilities;
@@ -2306,10 +2312,9 @@ interface DeleteDataCollectionPluginOptions {
     pluginType: PluginTypeWithLiterals;
 }
 /**
- * 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  in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
  *
- * Only updates the properties specified in the request, all other properties remain unchanged.
- * The following properties can be updated with this method: `displayName`, `type`, `typeMetadata`, `encrypted`, `description`. If attempting to update `key` or other unsupported properties, this operation fails.
+ * 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.