@wix/auto_sdk_data_collections 1.0.45 → 1.0.47

package/build/internal/es/index.typings.d.mts

@@ -1077,11 +1077,11 @@ interface RestoreDataCollectionResponse {
     dataCollection?: DataCollection;
 }
 interface PatchDataCollectionRequest {
-    /** Data collection to patch. Only fields specified in the field_mask are updated. */
+    /** Data collection to update. */
     dataCollection: DataCollection;
 }
 interface PatchDataCollectionResponse {
-    /** The updated data collection. */
+    /** Updated data collection. */
     dataCollection?: DataCollection;
 }
 interface CreateDataCollectionFieldRequest {
@@ -1134,7 +1134,7 @@ interface AddDataCollectionPluginRequest {
     dataCollectionId: string;
     /**
      * Plugin to add to the collection. Must include the plugin type and any type-specific configuration.
-     * If a plugin of the same type already exists, this operation will fail.
+     * If a plugin of the same type already exists in the collection, this operation fails.
      */
     plugin: Plugin;
 }
@@ -1161,7 +1161,7 @@ interface PatchDataCollectionFieldRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Field to patch. */
+    /** Field to update. */
     field: Field;
 }
 interface PatchDataCollectionFieldResponse {
@@ -1726,19 +1726,24 @@ interface ListDataCollectionsOptions {
 /**
  * Updates a data collection.
  *
- * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
+ * A collection ID, revision number, permissions, and at least 1 field must be provided in the `collection` body parameter.
  * If a collection with that ID exists, and if its current `revision` number matches the one provided, it's updated.
  * Otherwise, the request fails.
  *
- * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
- *
  * <blockquote class="important">
  * <strong>Important:</strong>
- * After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection
- * has properties with values and those properties aren't included in the updated collection details, their values are lost.<br/><br/>
  *
- * To update a single field, use the Update Data Collection Field method.
+ * After a collection is updated, it only contains the properties included in the Update Data Collection request.
+ * If the existing collection has properties with values and those properties aren't included in the updated collection details,
+ * their values are lost.<br/><br/>
+ *
+ * To update only specific properties without affecting others, use [Patch Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection).
  * </blockquote>
+ *
+ * When a collection is updated, its `updatedDate` changes to the current date and its `revision` increments by 1.
+ *
+ * To update only properties in a collection's `fields` array, use [Update Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/update-data-collection-field).
+ * To only 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 collection - Updated collection details. The existing collection is replaced with this version.
  * @public
  * @requiredField collection
@@ -1789,18 +1794,23 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
  */
 declare function restoreDataCollection(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.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>>;
 /**
- * Patches (partial update) a data collection.
+ * 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.
+ *
+ * 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.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField dataCollection
- * @requiredField dataCollection.revision
  * @permissionId WIX_DATA.UPDATE_COLLECTION
  * @applicableIdentity APP
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
  */
-declare function patchDataCollection(_id: string, dataCollection: NonNullablePaths<PatchDataCollection, `revision`, 2>): 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.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>>;
+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.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.
@@ -1918,7 +1928,16 @@ interface CreateDataCollectionFieldOptions {
     field: Field;
 }
 /**
- * Updates a field in the structure of a data collection.
+ * 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.
+ *
+ * <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/>
+ *
+ * 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>
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -1961,6 +1980,8 @@ interface DeleteDataCollectionFieldOptions {
 }
 /**
  * Adds a plugin to a data collection.
+ *
+ * If a plugin of the same type already exists in the collection, this operation fails.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -1976,12 +1997,14 @@ declare function addDataCollectionPlugin(dataCollectionId: string, options: NonN
 interface AddDataCollectionPluginOptions {
     /**
      * Plugin to add to the collection. Must include the plugin type and any type-specific configuration.
-     * If a plugin of the same type already exists, this operation will fail.
+     * If a plugin of the same type already exists in the collection, this operation fails.
      */
     plugin: Plugin;
 }
 /**
- * Deletes a plugin from a data collection.
+ * Removes a plugin from a data collection.
+ *
+ * Removing a plugin disables its functionality for the collection.
  * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
@@ -1998,9 +2021,14 @@ interface DeleteDataCollectionPluginOptions {
     pluginType: PluginTypeWithLiterals;
 }
 /**
- * Patches (partial update) a field in the structure of a data collection.
+ * 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.
+ *
+ * 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 patch.
+ * @param field - Field to update.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId

package/build/internal/es/index.typings.mjs

@@ -883,7 +883,7 @@ function patchDataCollectionField(payload) {
     ]);
     const metadata = {
       entityFqdn: "wix.data.v2.data_collection",
-      method: "POST",
+      method: "PATCH",
       methodFqn: "com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollectionField",
       packageName: PACKAGE_NAME,
       migrationOptions: {