@wix/auto_sdk_data_collections 1.0.46 → 1.0.49

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

@@ -436,6 +436,25 @@ interface CalculatorPatternOneOf {
     /** Value is only URL encoded. */
     urlizedOnlyPattern?: UrlizedOnlyPattern;
 }
+declare enum PageLinkType {
+    /** Default value. This value is unused. */
+    UNKNOWN_PAGE_LINK_TYPE = "UNKNOWN_PAGE_LINK_TYPE",
+    /**
+     * Page link with field substitution patterns stored in the data collection.
+     * Example: "path/{plainField}" where plainField can be any supported type.
+     * Can be persistent (stored in database) or overlay (calculated on-the-fly).
+     */
+    COLLECTION_DEFINED = "COLLECTION_DEFINED",
+    /**
+     * Page link with field substitution patterns provided by Routers Config.
+     * Only supports SLUG type fields in the template (e.g., "products/{slug}").
+     * Always read-only overlay fields (never persisted in database).
+     * Page link definitions are NOT stored in the data collection.
+     */
+    ROUTER_DEFINED = "ROUTER_DEFINED"
+}
+/** @enumType */
+type PageLinkTypeWithLiterals = PageLinkType | 'UNKNOWN_PAGE_LINK_TYPE' | 'COLLECTION_DEFINED' | 'ROUTER_DEFINED';
 interface Reference {
     /**
      * Referenced collection ID.
@@ -1046,11 +1065,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 {
@@ -1103,7 +1122,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;
 }
@@ -1130,7 +1149,7 @@ interface PatchDataCollectionFieldRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Field to patch. */
+    /** Field to update. */
     field: Field;
 }
 interface PatchDataCollectionFieldResponse {
@@ -1685,19 +1704,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
@@ -1734,6 +1758,24 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollection
  */
 declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
+/**
+ * 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField dataCollection
+ * @permissionId WIX_DATA.UPDATE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
+ */
+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.
@@ -1840,7 +1882,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
@@ -1883,6 +1934,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
@@ -1898,12 +1951,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
@@ -1920,9 +1975,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
@@ -1933,4 +1993,4 @@ interface DeleteDataCollectionPluginOptions {
  */
 declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.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>>;
 
-export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, TenantMode, type TenantModeWithLiterals, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UrlizedOnlyPattern, type UrlizedPluginOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollectionField, updateDataCollection, updateDataCollectionField };
+export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, TenantMode, type TenantModeWithLiterals, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UrlizedOnlyPattern, type UrlizedPluginOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateDataCollection, updateDataCollectionField };

package/build/cjs/index.typings.js

@@ -30,6 +30,7 @@ __export(index_typings_exports, {
   IndexSource: () => IndexSource,
   IndexStatus: () => IndexStatus,
   Order: () => Order,
+  PageLinkType: () => PageLinkType,
   PagingMode: () => PagingMode,
   PluginType: () => PluginType,
   QueryOperator: () => QueryOperator,
@@ -938,7 +939,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: {
@@ -1067,6 +1068,12 @@ var QueryOperator = /* @__PURE__ */ ((QueryOperator2) => {
   QueryOperator2["URLIZED"] = "URLIZED";
   return QueryOperator2;
 })(QueryOperator || {});
+var PageLinkType = /* @__PURE__ */ ((PageLinkType2) => {
+  PageLinkType2["UNKNOWN_PAGE_LINK_TYPE"] = "UNKNOWN_PAGE_LINK_TYPE";
+  PageLinkType2["COLLECTION_DEFINED"] = "COLLECTION_DEFINED";
+  PageLinkType2["ROUTER_DEFINED"] = "ROUTER_DEFINED";
+  return PageLinkType2;
+})(PageLinkType || {});
 var FieldPluginType = /* @__PURE__ */ ((FieldPluginType2) => {
   FieldPluginType2["UNKNOWN"] = "UNKNOWN";
   FieldPluginType2["CMS"] = "CMS";
@@ -1540,6 +1547,7 @@ async function patchDataCollectionField2(dataCollectionId, field) {
   IndexSource,
   IndexStatus,
   Order,
+  PageLinkType,
   PagingMode,
   PluginType,
   QueryOperator,