@wix/auto_sdk_data_collections 1.0.69 → 1.0.71

package/build/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;
@@ -122,7 +124,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[];
@@ -286,7 +288,6 @@ interface EnumValues {
     values?: string[];
 }
 declare enum Type {
-    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
     /** Plain-text string. */
     TEXT = "TEXT",
     /** Number. */
@@ -355,7 +356,7 @@ declare enum Type {
     LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
 }
 /** @enumType */
-type TypeWithLiterals = Type | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
+type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
 interface TypeMetadata extends TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
@@ -459,8 +460,6 @@ interface CalculatorPatternOneOf {
     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.
@@ -476,7 +475,7 @@ declare enum PageLinkType {
     ROUTER_DEFINED = "ROUTER_DEFINED"
 }
 /** @enumType */
-type PageLinkTypeWithLiterals = PageLinkType | 'UNKNOWN_PAGE_LINK_TYPE' | 'COLLECTION_DEFINED' | 'ROUTER_DEFINED';
+type PageLinkTypeWithLiterals = PageLinkType | 'COLLECTION_DEFINED' | 'ROUTER_DEFINED';
 interface Reference {
     /**
      * Referenced collection ID.
@@ -805,8 +804,6 @@ interface Permissions {
     read?: RoleWithLiterals;
 }
 declare enum Role {
-    /** Unknown role. */
-    UNKNOWN_ROLE = "UNKNOWN_ROLE",
     /** Site administrator. */
     ADMIN = "ADMIN",
     /** Signed-in user who added content to this collection. */
@@ -817,7 +814,7 @@ declare enum Role {
     ANYONE = "ANYONE"
 }
 /** @enumType */
-type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'ADMIN' | 'SITE_MEMBER_AUTHOR' | 'SITE_MEMBER' | 'ANYONE';
+type RoleWithLiterals = Role | 'ADMIN' | 'SITE_MEMBER_AUTHOR' | 'SITE_MEMBER' | 'ANYONE';
 /** Plugins that extend collection functionality. */
 interface Plugin extends PluginOptionsOneOf {
     /**
@@ -857,21 +854,19 @@ interface PluginOptionsOneOf {
     cmsOptions?: PluginCmsOptions;
 }
 declare enum Status {
-    UNKNOWN_PUBLISH_PLUGIN_STATUS = "UNKNOWN_PUBLISH_PLUGIN_STATUS",
     PUBLISHED = "PUBLISHED",
     DRAFT = "DRAFT"
 }
 /** @enumType */
-type StatusWithLiterals = Status | 'UNKNOWN_PUBLISH_PLUGIN_STATUS' | 'PUBLISHED' | 'DRAFT';
+type StatusWithLiterals = Status | 'PUBLISHED' | 'DRAFT';
 declare enum Format {
-    UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
     /** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
     ORIGINAL = "ORIGINAL",
     /** No changes are made before generating the encoded URL. */
     PLAIN = "PLAIN"
 }
 /** @enumType */
-type FormatWithLiterals = Format | 'UNKNOWN_URLIZED_PLUGIN_FORMAT' | 'ORIGINAL' | 'PLAIN';
+type FormatWithLiterals = Format | 'ORIGINAL' | 'PLAIN';
 /** if CMS-defined sort is enabled and should be used in site */
 interface SiteSort {
     /**
@@ -881,8 +876,6 @@ interface SiteSort {
     sort?: Sort[];
 }
 declare enum PluginType {
-    /** Unknown plugin type. */
-    UNKNOWN_PLUGIN_TYPE = "UNKNOWN_PLUGIN_TYPE",
     /** Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors. */
     PUBLISH = "PUBLISH",
     /** Ensures the collection can have one item at most. Can only be applied to a new collection. */
@@ -901,7 +894,7 @@ declare enum PluginType {
     CMS = "CMS"
 }
 /** @enumType */
-type PluginTypeWithLiterals = PluginType | 'UNKNOWN_PLUGIN_TYPE' | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
+type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
 interface PublishPluginOptions {
     /** Default status. */
     defaultStatus?: StatusWithLiterals;
@@ -1025,8 +1018,6 @@ interface DataPermissions {
  * Each level includes all levels below it (except UNDEFINED).
  */
 declare enum AccessLevel {
-    /** Not set. */
-    UNDEFINED = "UNDEFINED",
     /** Any subject, including visitors. */
     ANYONE = "ANYONE",
     /** Any signed-in user (both site members and collaborators). */
@@ -1039,7 +1030,7 @@ declare enum AccessLevel {
     PRIVILEGED = "PRIVILEGED"
 }
 /** @enumType */
-type AccessLevelWithLiterals = AccessLevel | 'UNDEFINED' | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
+type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
 interface AllowedDataPermissions {
     /** If data items read permitted */
     itemRead?: boolean;
@@ -1606,8 +1597,6 @@ interface Failure {
     itemId?: string | null;
 }
 declare enum IndexSource {
-    /** Place holder. Never returned by the service. */
-    UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
     /**
      * Automatically created by Wix for all collections.
      *
@@ -1627,7 +1616,7 @@ declare enum IndexSource {
     AUTO = "AUTO"
 }
 /** @enumType */
-type IndexSourceWithLiterals = IndexSource | 'UNKNOWN_INDEX_SOURCE' | 'SYSTEM' | 'USER' | 'AUTO';
+type IndexSourceWithLiterals = IndexSource | 'SYSTEM' | 'USER' | 'AUTO';
 interface CreateDataCollectionsSnapshotRequest {
 }
 interface CreateDataCollectionsSnapshotResponse {
@@ -2044,11 +2033,13 @@ 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.
+ * 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
@@ -2060,7 +2051,8 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
 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
      */
@@ -2107,6 +2099,7 @@ interface PatchDataCollection {
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
+     * Capabilities are set by default. Values depend on the collection type.
      * @readonly
      */
     capabilities?: CollectionCapabilities;
@@ -2254,10 +2247,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.

package/build/cjs/index.typings.js

@@ -1311,7 +1311,6 @@ var CollectionOperation = /* @__PURE__ */ ((CollectionOperation2) => {
   return CollectionOperation2;
 })(CollectionOperation || {});
 var Type = /* @__PURE__ */ ((Type2) => {
-  Type2["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
   Type2["TEXT"] = "TEXT";
   Type2["NUMBER"] = "NUMBER";
   Type2["DATE"] = "DATE";
@@ -1362,7 +1361,6 @@ var QueryOperator = /* @__PURE__ */ ((QueryOperator2) => {
   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;
@@ -1378,7 +1376,6 @@ var Permission = /* @__PURE__ */ ((Permission2) => {
   return Permission2;
 })(Permission || {});
 var Role = /* @__PURE__ */ ((Role2) => {
-  Role2["UNKNOWN_ROLE"] = "UNKNOWN_ROLE";
   Role2["ADMIN"] = "ADMIN";
   Role2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
   Role2["SITE_MEMBER"] = "SITE_MEMBER";
@@ -1386,19 +1383,16 @@ var Role = /* @__PURE__ */ ((Role2) => {
   return Role2;
 })(Role || {});
 var Status = /* @__PURE__ */ ((Status2) => {
-  Status2["UNKNOWN_PUBLISH_PLUGIN_STATUS"] = "UNKNOWN_PUBLISH_PLUGIN_STATUS";
   Status2["PUBLISHED"] = "PUBLISHED";
   Status2["DRAFT"] = "DRAFT";
   return Status2;
 })(Status || {});
 var Format = /* @__PURE__ */ ((Format2) => {
-  Format2["UNKNOWN_URLIZED_PLUGIN_FORMAT"] = "UNKNOWN_URLIZED_PLUGIN_FORMAT";
   Format2["ORIGINAL"] = "ORIGINAL";
   Format2["PLAIN"] = "PLAIN";
   return Format2;
 })(Format || {});
 var PluginType = /* @__PURE__ */ ((PluginType2) => {
-  PluginType2["UNKNOWN_PLUGIN_TYPE"] = "UNKNOWN_PLUGIN_TYPE";
   PluginType2["PUBLISH"] = "PUBLISH";
   PluginType2["SINGLE_ITEM"] = "SINGLE_ITEM";
   PluginType2["URLIZED"] = "URLIZED";
@@ -1415,7 +1409,6 @@ var PagingMode = /* @__PURE__ */ ((PagingMode2) => {
   return PagingMode2;
 })(PagingMode || {});
 var AccessLevel = /* @__PURE__ */ ((AccessLevel2) => {
-  AccessLevel2["UNDEFINED"] = "UNDEFINED";
   AccessLevel2["ANYONE"] = "ANYONE";
   AccessLevel2["SITE_MEMBER"] = "SITE_MEMBER";
   AccessLevel2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
@@ -1456,7 +1449,6 @@ var IndexStatus = /* @__PURE__ */ ((IndexStatus2) => {
   return IndexStatus2;
 })(IndexStatus || {});
 var IndexSource = /* @__PURE__ */ ((IndexSource2) => {
-  IndexSource2["UNKNOWN_INDEX_SOURCE"] = "UNKNOWN_INDEX_SOURCE";
   IndexSource2["SYSTEM"] = "SYSTEM";
   IndexSource2["USER"] = "USER";
   IndexSource2["AUTO"] = "AUTO";