@wix/auto_sdk_data_collections 1.0.38 → 1.0.40

package/build/cjs/meta.d.ts

@@ -482,6 +482,13 @@ interface PageLink {
      */
     linkedRouterPage?: string | null;
 }
+interface Slug {
+    /**
+     * @minLength 1
+     * @maxLength 1000
+     */
+    pattern?: string;
+}
 interface NumberRange {
     /**
      * Minimum permitted value for a numerical field.
@@ -1154,7 +1161,7 @@ interface SnapshotCollection {
 /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
 interface Index {
     /**
-     * Id of the index.
+     * ID of the index.
      * @readonly
      * @format GUID
      */
@@ -1184,8 +1191,8 @@ interface Index {
      */
     failure?: Failure;
     /**
-     * Whether the index enforces uniqueness of values in the field for which it is defined.
-     * If `true`, the index can have only one field.
+     * Whether the index enforces uniqueness of values in the field for which it's defined.
+     * If `true`, the index can have only 1 field.
      *
      * Default: `false`
      */
@@ -1196,7 +1203,11 @@ interface Index {
      * Default: `false`
      */
     caseInsensitive?: boolean;
-    /** Specifies the origin of the index definition. */
+    /**
+     * Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types#index-sources).
+     *
+     * Default: `USER`
+     */
     source?: IndexSourceWithLiterals;
 }
 /**
@@ -1265,11 +1276,22 @@ interface Failure {
 declare enum IndexSource {
     /** Place holder. Never returned by the service. */
     UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
-    /** Index is created by the system, present for all collections. */
+    /**
+     * Automatically created by Wix for all collections.
+     *
+     * System indexes are created for essential attributes, such as ID and creation date.
+     * You can't delete them and they don't count towards the index limit.
+     */
     SYSTEM = "SYSTEM",
-    /** Index was created by a user via API or UI. */
+    /** Created by a Wix user via the API or in the dashboard. */
     USER = "USER",
-    /** Index is created automatically by the system based on user queries. */
+    /**
+     * Created automatically by Wix based on a Wix user's queries.
+     *
+     * For large collections, Wix identifies slow-running queries and creates indexes automatically to improve performance.
+     * These indexes don't count towards the index limit. They're created dynamically, and may be deleted if they no longer fit
+     * the system's parameters. To keep an automatic index permanently, manually create an identical `USER` index.
+     */
     AUTO = "AUTO"
 }
 /** @enumType */
@@ -1553,4 +1575,4 @@ declare function createDataCollectionField(): __PublicMethodMetaInfo<'POST', {},
 declare function updateDataCollectionField(): __PublicMethodMetaInfo<'POST', {}, UpdateDataCollectionFieldRequest$1, UpdateDataCollectionFieldRequest, UpdateDataCollectionFieldResponse$1, UpdateDataCollectionFieldResponse>;
 declare function deleteDataCollectionField(): __PublicMethodMetaInfo<'POST', {}, DeleteDataCollectionFieldRequest$1, DeleteDataCollectionFieldRequest, DeleteDataCollectionFieldResponse$1, DeleteDataCollectionFieldResponse>;
 
-export { AccessLevel as AccessLevelOriginal, type AccessLevelWithLiterals as AccessLevelWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type AllowedDataPermissions as AllowedDataPermissionsOriginal, type AppOptions as AppOptionsOriginal, type ApplicationError as ApplicationErrorOriginal, type ArraySizeRange as ArraySizeRangeOriginal, type BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequestOriginal, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf as BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOfOriginal, type BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponseOriginal, type BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequestOriginal, type BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponseOriginal, type Calculator as CalculatorOriginal, type CalculatorPatternOneOf as CalculatorPatternOneOfOriginal, type CatalogOptions as CatalogOptionsOriginal, type CmsOptions as CmsOptionsOriginal, type CollectionCapabilities as CollectionCapabilitiesOriginal, type CollectionDefinition as CollectionDefinitionOriginal, CollectionOperation as CollectionOperationOriginal, type CollectionOperationWithLiterals as CollectionOperationWithLiteralsOriginal, CollectionType as CollectionTypeOriginal, type CollectionTypeWithLiterals as CollectionTypeWithLiteralsOriginal, type CreateAppCollectionsSnapshotRequest as CreateAppCollectionsSnapshotRequestOriginal, type CreateAppCollectionsSnapshotResponse as CreateAppCollectionsSnapshotResponseOriginal, type CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequestOriginal, type CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponseOriginal, type CreateDataCollectionRequest as CreateDataCollectionRequestOriginal, type CreateDataCollectionResponse as CreateDataCollectionResponseOriginal, type CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequestOriginal, type CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponseOriginal, type CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequestOriginal, type CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponseOriginal, type DataCollectionChangedEvent as DataCollectionChangedEventOriginal, type DataCollectionClonedEvent as DataCollectionClonedEventOriginal, type DataCollectionEvictedEvent as DataCollectionEvictedEventOriginal, type DataCollection as DataCollectionOriginal, DataOperation as DataOperationOriginal, type DataOperationWithLiterals as DataOperationWithLiteralsOriginal, type DataPermissions as DataPermissionsOriginal, type DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequestOriginal, type DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponseOriginal, type DeleteDataCollectionRequest as DeleteDataCollectionRequestOriginal, type DeleteDataCollectionResponse as DeleteDataCollectionResponseOriginal, type DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequestOriginal, type DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponseOriginal, type Destination as DestinationOriginal, Direction as DirectionOriginal, type DirectionWithLiterals as DirectionWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FailedCollection as FailedCollectionOriginal, type Failure as FailureOriginal, type FieldCapabilities as FieldCapabilitiesOriginal, type Field as FieldOriginal, type FieldPluginOptionsOneOf as FieldPluginOptionsOneOfOriginal, type FieldPlugin as FieldPluginOriginal, FieldPluginType as FieldPluginTypeOriginal, type FieldPluginTypeWithLiterals as FieldPluginTypeWithLiteralsOriginal, type FieldRangeValidationsOneOf as FieldRangeValidationsOneOfOriginal, type FieldUpdate as FieldUpdateOriginal, type FieldsPattern as FieldsPatternOriginal, Format as FormatOriginal, type FormatWithLiterals as FormatWithLiteralsOriginal, type GetDataCollectionRequest as GetDataCollectionRequestOriginal, type GetDataCollectionResponse as GetDataCollectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IndexField as IndexFieldOriginal, type IndexLimits as IndexLimitsOriginal, type Index as IndexOriginal, type IndexQuotaLimits as IndexQuotaLimitsOriginal, IndexSource as IndexSourceOriginal, type IndexSourceWithLiterals as IndexSourceWithLiteralsOriginal, IndexStatus as IndexStatusOriginal, type IndexStatusWithLiterals as IndexStatusWithLiteralsOriginal, type ListDataCollectionsRequest as ListDataCollectionsRequestOriginal, type ListDataCollectionsResponse as ListDataCollectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiReference as MultiReferenceOriginal, type MultilingualOptions as MultilingualOptionsOriginal, type NumberRange as NumberRangeOriginal, type ObjectField as ObjectFieldOriginal, Order as OrderOriginal, type OrderWithLiterals as OrderWithLiteralsOriginal, type PageLink as PageLinkOriginal, type PageLinkPluginOptions as PageLinkPluginOptionsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, PagingMode as PagingModeOriginal, type PagingModeWithLiterals as PagingModeWithLiteralsOriginal, type Paging as PagingOriginal, type Permissions as PermissionsOriginal, type PluginCmsOptions as PluginCmsOptionsOriginal, type PluginOptionsOneOf as PluginOptionsOneOfOriginal, type Plugin as PluginOriginal, PluginType as PluginTypeOriginal, type PluginTypeWithLiterals as PluginTypeWithLiteralsOriginal, type PluginUpdate as PluginUpdateOriginal, type PublishPluginOptions as PublishPluginOptionsOriginal, QueryOperator as QueryOperatorOriginal, type QueryOperatorWithLiterals as QueryOperatorWithLiteralsOriginal, type Reference as ReferenceOriginal, type RestorationCollection as RestorationCollectionOriginal, type RestoreDataCollectionRequest as RestoreDataCollectionRequestOriginal, type RestoreDataCollectionResponse as RestoreDataCollectionResponseOriginal, type RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequestOriginal, type RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponseOriginal, type RestoreInfo as RestoreInfoOriginal, Role as RoleOriginal, type RoleWithLiterals as RoleWithLiteralsOriginal, Segment as SegmentOriginal, type SegmentWithLiterals as SegmentWithLiteralsOriginal, type SingleItemPluginOptions as SingleItemPluginOptionsOriginal, type SiteSort as SiteSortOriginal, type SnapshotCollection as SnapshotCollectionOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sort as SortOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StringLengthRange as StringLengthRangeOriginal, TenantMode as TenantModeOriginal, type TenantModeWithLiterals as TenantModeWithLiteralsOriginal, type TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOfOriginal, type TypeMetadata as TypeMetadataOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequestOriginal, type UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponseOriginal, type UpdateDataCollectionRequest as UpdateDataCollectionRequestOriginal, type UpdateDataCollectionResponse as UpdateDataCollectionResponseOriginal, type UpdateDataPermissionsRequest as UpdateDataPermissionsRequestOriginal, type UpdateDataPermissionsResponse as UpdateDataPermissionsResponseOriginal, type UrlizedOnlyPattern as UrlizedOnlyPatternOriginal, type UrlizedPluginOptions as UrlizedPluginOptionsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type _Array as _ArrayOriginal, type _Object as _ObjectOriginal, type __PublicMethodMetaInfo, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, getDataCollection, listDataCollections, restoreDataCollection, updateDataCollection, updateDataCollectionField };
+export { AccessLevel as AccessLevelOriginal, type AccessLevelWithLiterals as AccessLevelWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type AllowedDataPermissions as AllowedDataPermissionsOriginal, type AppOptions as AppOptionsOriginal, type ApplicationError as ApplicationErrorOriginal, type ArraySizeRange as ArraySizeRangeOriginal, type BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequestOriginal, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf as BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOfOriginal, type BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponseOriginal, type BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequestOriginal, type BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponseOriginal, type Calculator as CalculatorOriginal, type CalculatorPatternOneOf as CalculatorPatternOneOfOriginal, type CatalogOptions as CatalogOptionsOriginal, type CmsOptions as CmsOptionsOriginal, type CollectionCapabilities as CollectionCapabilitiesOriginal, type CollectionDefinition as CollectionDefinitionOriginal, CollectionOperation as CollectionOperationOriginal, type CollectionOperationWithLiterals as CollectionOperationWithLiteralsOriginal, CollectionType as CollectionTypeOriginal, type CollectionTypeWithLiterals as CollectionTypeWithLiteralsOriginal, type CreateAppCollectionsSnapshotRequest as CreateAppCollectionsSnapshotRequestOriginal, type CreateAppCollectionsSnapshotResponse as CreateAppCollectionsSnapshotResponseOriginal, type CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequestOriginal, type CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponseOriginal, type CreateDataCollectionRequest as CreateDataCollectionRequestOriginal, type CreateDataCollectionResponse as CreateDataCollectionResponseOriginal, type CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequestOriginal, type CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponseOriginal, type CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequestOriginal, type CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponseOriginal, type DataCollectionChangedEvent as DataCollectionChangedEventOriginal, type DataCollectionClonedEvent as DataCollectionClonedEventOriginal, type DataCollectionEvictedEvent as DataCollectionEvictedEventOriginal, type DataCollection as DataCollectionOriginal, DataOperation as DataOperationOriginal, type DataOperationWithLiterals as DataOperationWithLiteralsOriginal, type DataPermissions as DataPermissionsOriginal, type DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequestOriginal, type DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponseOriginal, type DeleteDataCollectionRequest as DeleteDataCollectionRequestOriginal, type DeleteDataCollectionResponse as DeleteDataCollectionResponseOriginal, type DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequestOriginal, type DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponseOriginal, type Destination as DestinationOriginal, Direction as DirectionOriginal, type DirectionWithLiterals as DirectionWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FailedCollection as FailedCollectionOriginal, type Failure as FailureOriginal, type FieldCapabilities as FieldCapabilitiesOriginal, type Field as FieldOriginal, type FieldPluginOptionsOneOf as FieldPluginOptionsOneOfOriginal, type FieldPlugin as FieldPluginOriginal, FieldPluginType as FieldPluginTypeOriginal, type FieldPluginTypeWithLiterals as FieldPluginTypeWithLiteralsOriginal, type FieldRangeValidationsOneOf as FieldRangeValidationsOneOfOriginal, type FieldUpdate as FieldUpdateOriginal, type FieldsPattern as FieldsPatternOriginal, Format as FormatOriginal, type FormatWithLiterals as FormatWithLiteralsOriginal, type GetDataCollectionRequest as GetDataCollectionRequestOriginal, type GetDataCollectionResponse as GetDataCollectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IndexField as IndexFieldOriginal, type IndexLimits as IndexLimitsOriginal, type Index as IndexOriginal, type IndexQuotaLimits as IndexQuotaLimitsOriginal, IndexSource as IndexSourceOriginal, type IndexSourceWithLiterals as IndexSourceWithLiteralsOriginal, IndexStatus as IndexStatusOriginal, type IndexStatusWithLiterals as IndexStatusWithLiteralsOriginal, type ListDataCollectionsRequest as ListDataCollectionsRequestOriginal, type ListDataCollectionsResponse as ListDataCollectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiReference as MultiReferenceOriginal, type MultilingualOptions as MultilingualOptionsOriginal, type NumberRange as NumberRangeOriginal, type ObjectField as ObjectFieldOriginal, Order as OrderOriginal, type OrderWithLiterals as OrderWithLiteralsOriginal, type PageLink as PageLinkOriginal, type PageLinkPluginOptions as PageLinkPluginOptionsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, PagingMode as PagingModeOriginal, type PagingModeWithLiterals as PagingModeWithLiteralsOriginal, type Paging as PagingOriginal, type Permissions as PermissionsOriginal, type PluginCmsOptions as PluginCmsOptionsOriginal, type PluginOptionsOneOf as PluginOptionsOneOfOriginal, type Plugin as PluginOriginal, PluginType as PluginTypeOriginal, type PluginTypeWithLiterals as PluginTypeWithLiteralsOriginal, type PluginUpdate as PluginUpdateOriginal, type PublishPluginOptions as PublishPluginOptionsOriginal, QueryOperator as QueryOperatorOriginal, type QueryOperatorWithLiterals as QueryOperatorWithLiteralsOriginal, type Reference as ReferenceOriginal, type RestorationCollection as RestorationCollectionOriginal, type RestoreDataCollectionRequest as RestoreDataCollectionRequestOriginal, type RestoreDataCollectionResponse as RestoreDataCollectionResponseOriginal, type RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequestOriginal, type RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponseOriginal, type RestoreInfo as RestoreInfoOriginal, Role as RoleOriginal, type RoleWithLiterals as RoleWithLiteralsOriginal, Segment as SegmentOriginal, type SegmentWithLiterals as SegmentWithLiteralsOriginal, type SingleItemPluginOptions as SingleItemPluginOptionsOriginal, type SiteSort as SiteSortOriginal, type Slug as SlugOriginal, type SnapshotCollection as SnapshotCollectionOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sort as SortOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StringLengthRange as StringLengthRangeOriginal, TenantMode as TenantModeOriginal, type TenantModeWithLiterals as TenantModeWithLiteralsOriginal, type TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOfOriginal, type TypeMetadata as TypeMetadataOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequestOriginal, type UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponseOriginal, type UpdateDataCollectionRequest as UpdateDataCollectionRequestOriginal, type UpdateDataCollectionResponse as UpdateDataCollectionResponseOriginal, type UpdateDataPermissionsRequest as UpdateDataPermissionsRequestOriginal, type UpdateDataPermissionsResponse as UpdateDataPermissionsResponseOriginal, type UrlizedOnlyPattern as UrlizedOnlyPatternOriginal, type UrlizedPluginOptions as UrlizedPluginOptionsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type _Array as _ArrayOriginal, type _Object as _ObjectOriginal, type __PublicMethodMetaInfo, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, getDataCollection, listDataCollections, restoreDataCollection, updateDataCollection, updateDataCollectionField };