@wix/auto_sdk_data_collections 1.0.0 → 1.0.1

package/build/cjs/src/data-v2-data-collection-collections.types.d.ts

@@ -1,6 +1,10 @@
 /** A data collection determines the structure of data to be stored in a database. */
 export interface DataCollection {
-    /** Collection ID. For example, `my-first-collection`. May include a namespace. */
+    /**
+     * Collection ID. For example, `my-first-collection`. May include a namespace.
+     * @immutable
+     * @maxLength 256
+     */
     id?: string;
     /**
      * Collection type. Indicates how the collection was created and how it is stored.
@@ -9,6 +13,7 @@ export interface DataCollection {
     collectionType?: CollectionType;
     /**
      * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
+     * @format GUID
      * @readonly
      */
     ownerAppId?: string | null;
@@ -19,7 +24,10 @@ export interface DataCollection {
      * @readonly
      */
     maxPageSize?: number | null;
-    /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
+    /**
+     * Collection's display name as shown in the CMS. For example, `My First Collection`.
+     * @maxLength 1000
+     */
     displayName?: string | null;
     /**
      * Default item sorting order when a query doesn't specify one.
@@ -30,16 +38,23 @@ export interface DataCollection {
      * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
      * Empty for all data collections not owned by Wix apps.
      * @readonly
+     * @maxLength 1000
      */
     displayNamespace?: string | null;
-    /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    /**
+     * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
+     * @maxLength 1000
+     */
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
      * @readonly
      */
     capabilities?: CollectionCapabilities;
-    /** Collection's field structure. */
+    /**
+     * Collection's field structure.
+     * @maxSize 1000
+     */
     fields?: Field[];
     /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
     permissions?: Permissions;
@@ -48,11 +63,15 @@ export interface DataCollection {
      * @readonly
      */
     revision?: string | null;
-    /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    /**
+     * Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality.
+     * @maxSize 100
+     */
     plugins?: Plugin[];
     /**
      * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
      * @readonly
+     * @maxSize 2
      */
     pagingModes?: PagingMode[];
     /**
@@ -77,7 +96,10 @@ export declare enum CollectionType {
     EXTERNAL = "EXTERNAL"
 }
 export interface Sort {
-    /** Field to sort by. */
+    /**
+     * Field to sort by.
+     * @maxLength 1000
+     */
     fieldKey?: string;
     /**
      * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
@@ -95,9 +117,13 @@ export 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.
+     * @maxSize 100
      */
     dataOperations?: DataOperation[];
-    /** Collection operations supported. The listed operations can be performed on the collection itself. */
+    /**
+     * Collection operations supported. The listed operations can be performed on the collection itself.
+     * @maxSize 100
+     */
     collectionOperations?: CollectionOperation[];
     /** Maximum number of indexes for the collection. */
     indexLimits?: IndexLimits;
@@ -146,9 +172,15 @@ export interface Field extends FieldRangeValidationsOneOf {
     stringLengthRange?: StringLengthRange;
     /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */
     arraySizeRange?: ArraySizeRange;
-    /** Unique identifier for the field. For example, `firstName`. */
+    /**
+     * Unique identifier for the field. For example, `firstName`.
+     * @maxLength 1000
+     */
     key?: string;
-    /** Field's display name when displayed in the CMS. For example, `First Name`. */
+    /**
+     * Field's display name when displayed in the CMS. For example, `First Name`.
+     * @maxLength 1000
+     */
     displayName?: string | null;
     /** Field's data type. */
     type?: Type;
@@ -166,7 +198,10 @@ export interface Field extends FieldRangeValidationsOneOf {
     capabilities?: FieldCapabilities;
     /** Whether the field is encrypted. */
     encrypted?: boolean;
-    /** Field description. */
+    /**
+     * Field description.
+     * @maxLength 16000
+     */
     description?: string | null;
     /**
      * Whether the field is read-only. A read-only field can't be changed.
@@ -186,7 +221,10 @@ export interface Field extends FieldRangeValidationsOneOf {
      * Default: `false`
      */
     required?: boolean | null;
-    /** Additional optional plugins for the field. */
+    /**
+     * Additional optional plugins for the field.
+     * @maxSize 100
+     */
     plugins?: FieldPlugin[];
 }
 /** @oneof */
@@ -271,7 +309,10 @@ export interface FieldCapabilities {
      * Default: `false`
      */
     sortable?: boolean;
-    /** Query operators that can be used for this field. */
+    /**
+     * Query operators that can be used for this field.
+     * @maxSize 100
+     */
     queryOperators?: QueryOperator[];
 }
 export declare enum QueryOperator {
@@ -290,9 +331,15 @@ export declare enum QueryOperator {
     URLIZED = "URLIZED"
 }
 export interface ObjectField {
-    /** Field ID. */
+    /**
+     * Field ID.
+     * @maxLength 1000
+     */
     key?: string;
-    /** Display name for the field. */
+    /**
+     * Display name for the field.
+     * @maxLength 1000
+     */
     displayName?: string | null;
     /** Field type. */
     type?: Type;
@@ -305,10 +352,12 @@ export interface ObjectField {
     capabilities?: FieldCapabilities;
 }
 export interface FieldsPattern {
+    /** @maxLength 1000 */
     pattern?: string;
     lowercase?: boolean;
 }
 export interface UrlizedOnlyPattern {
+    /** @maxLength 1000 */
     pattern?: string;
 }
 export interface Calculator extends CalculatorPatternOneOf {
@@ -325,19 +374,34 @@ export interface CalculatorPatternOneOf {
     urlizedOnlyPattern?: UrlizedOnlyPattern;
 }
 export interface Reference {
-    /** Referenced collection ID. */
+    /**
+     * Referenced collection ID.
+     * @maxLength 256
+     */
     referencedCollectionId?: string;
 }
 export interface MultiReference {
-    /** Referenced collection ID. */
+    /**
+     * Referenced collection ID.
+     * @maxLength 256
+     */
     referencedCollectionId?: string;
-    /** Referencing field ID. */
+    /**
+     * Referencing field ID.
+     * @maxLength 1000
+     */
     referencingFieldKey?: string;
-    /** Display name in the CMS for the referenced data. */
+    /**
+     * Display name in the CMS for the referenced data.
+     * @maxLength 1000
+     */
     referencingDisplayName?: string;
 }
 export interface _Object {
-    /** Fields within the object. */
+    /**
+     * Fields within the object.
+     * @maxSize 1000
+     */
     fields?: ObjectField[];
 }
 export interface _Array {
@@ -348,7 +412,10 @@ export interface _Array {
 }
 export interface PageLink {
     calculator?: Calculator;
-    /** Defines reference to router pattern in the site document. */
+    /**
+     * Defines reference to router pattern in the site document.
+     * @maxLength 1000
+     */
     linkedRouterPage?: string | null;
 }
 export interface NumberRange {
@@ -493,7 +560,10 @@ export declare enum Format {
 }
 /** if CMS-defined sort is enabled and should be used in site */
 export interface SiteSort {
-    /** Field and order for the site sort. */
+    /**
+     * Field and order for the site sort.
+     * @maxSize 100
+     */
     sort?: Sort[];
 }
 export declare enum PluginType {
@@ -521,7 +591,10 @@ export interface PublishPluginOptions {
     defaultStatus?: Status;
 }
 export interface SingleItemPluginOptions {
-    /** ID of the single item in this collection. If you insert or update an item, its ID value is always changed to this. */
+    /**
+     * ID of the single item in this collection. If you insert or update an item, its ID value is always changed to this.
+     * @maxLength 16000
+     */
     singleItemId?: string;
 }
 export interface UrlizedPluginOptions {
@@ -529,7 +602,11 @@ export interface UrlizedPluginOptions {
     format?: Format;
 }
 export interface MultilingualOptions {
-    /** IDs of fields to allow translation. */
+    /**
+     * IDs of fields to allow translation.
+     * @maxSize 1000
+     * @maxLength 1000
+     */
     translatableFieldKeys?: string[];
 }
 export interface PageLinkPluginOptions {
@@ -586,23 +663,47 @@ export interface AllowedDataPermissions {
     itemRemove?: boolean;
 }
 export interface DataCollectionClonedEvent {
-    /** Instance ID of the collection from which the data is cloned. */
+    /**
+     * Instance ID of the collection from which the data is cloned.
+     * @format GUID
+     */
     originInstanceId?: string;
-    /** ID of the collection from which the data is cloned. */
+    /**
+     * ID of the collection from which the data is cloned.
+     * @maxLength 256
+     */
     originId?: string;
 }
 export interface DataCollectionChangedEvent {
-    /** list of new fields */
+    /**
+     * list of new fields
+     * @maxSize 1000
+     */
     fieldsAdded?: Field[];
-    /** list of changed fields */
+    /**
+     * list of changed fields
+     * @maxSize 1000
+     */
     fieldsUpdated?: FieldUpdate[];
-    /** list of removed fields */
+    /**
+     * list of removed fields
+     * @maxSize 1000
+     */
     fieldsRemoved?: Field[];
-    /** list of new plugins */
+    /**
+     * list of new plugins
+     * @maxSize 100
+     */
     pluginsAdded?: Plugin[];
-    /** list of changed plugins */
+    /**
+     * list of changed plugins
+     * @maxSize 100
+     */
     pluginsUpdated?: PluginUpdate[];
-    /** list of removed plugins */
+    /**
+     * list of removed plugins
+     * @maxSize 100
+     */
     pluginsRemoved?: Plugin[];
 }
 export interface FieldUpdate {
@@ -618,7 +719,11 @@ export interface PluginUpdate {
     current?: Plugin;
 }
 export interface DataCollectionEvictedEvent {
-    /** ID of the collection that was permanently deleted. */
+    /**
+     * ID of the collection that was permanently deleted.
+     * @minLength 1
+     * @maxLength 1000
+     */
     id?: string;
 }
 export interface CreateDataCollectionRequest {
@@ -630,7 +735,10 @@ export interface CreateDataCollectionResponse {
     collection?: DataCollection;
 }
 export interface GetDataCollectionRequest {
-    /** ID of the collection to retrieve. */
+    /**
+     * ID of the collection to retrieve.
+     * @maxLength 256
+     */
     dataCollectionId: string;
     /**
      * Whether to retrieve data from the primary database instance.
@@ -643,6 +751,8 @@ export interface GetDataCollectionRequest {
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
+     * @maxSize 100
+     * @maxLength 1000
      */
     fields?: string[];
 }
@@ -680,11 +790,16 @@ export interface ListDataCollectionsRequest {
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
+     * @maxSize 100
+     * @maxLength 128
      */
     fields?: string[];
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 1000
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -716,7 +831,12 @@ export interface PagingMetadataV2 {
     tooManyToCount?: boolean | null;
 }
 export interface BulkGetDataCollectionsRequest {
-    /** IDs of the collections to retrieve. */
+    /**
+     * IDs of the collections to retrieve.
+     * @minSize 1
+     * @maxSize 100
+     * @maxLength 256
+     */
     dataCollectionIds?: string[];
     /**
      * Whether to include deleted collections.
@@ -743,6 +863,8 @@ export interface BulkGetDataCollectionsRequest {
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
+     * @maxSize 100
+     * @maxLength 1000
      */
     fields?: string[];
 }
@@ -764,13 +886,19 @@ export interface UpdateDataCollectionResponse {
     collection?: DataCollection;
 }
 export interface DeleteDataCollectionRequest {
-    /** ID of the collection to delete. */
+    /**
+     * ID of the collection to delete.
+     * @maxLength 256
+     */
     dataCollectionId: string;
 }
 export interface DeleteDataCollectionResponse {
 }
 export interface RestoreDataCollectionRequest {
-    /** Data Collection ID to restore */
+    /**
+     * Data Collection ID to restore
+     * @maxLength 256
+     */
     dataCollectionId?: string;
 }
 export interface RestoreDataCollectionResponse {
@@ -778,7 +906,10 @@ export interface RestoreDataCollectionResponse {
     dataCollection?: DataCollection;
 }
 export interface CreateDataCollectionFieldRequest {
-    /** ID of data collection to update */
+    /**
+     * ID of data collection to update
+     * @maxLength 256
+     */
     dataCollectionId: string;
     /** field to create */
     field: Field;
@@ -788,7 +919,10 @@ export interface CreateDataCollectionFieldResponse {
     dataCollection?: DataCollection;
 }
 export interface UpdateDataCollectionFieldRequest {
-    /** ID of data collection to update */
+    /**
+     * ID of data collection to update
+     * @maxLength 256
+     */
     dataCollectionId: string;
     /** Field to update */
     field: Field;
@@ -798,9 +932,15 @@ export interface UpdateDataCollectionFieldResponse {
     dataCollection?: DataCollection;
 }
 export interface DeleteDataCollectionFieldRequest {
-    /** ID of data collection to update */
+    /**
+     * ID of data collection to update
+     * @maxLength 256
+     */
     dataCollectionId: string;
-    /** Field ID to delete */
+    /**
+     * Field ID to delete
+     * @maxLength 1000
+     */
     fieldKey: string;
 }
 export interface DeleteDataCollectionFieldResponse {
@@ -808,7 +948,10 @@ export interface DeleteDataCollectionFieldResponse {
     dataCollection?: DataCollection;
 }
 export interface UpdateDataPermissionsRequest {
-    /** ID of data collections to update */
+    /**
+     * ID of data collections to update
+     * @maxLength 256
+     */
     dataCollectionId?: string;
     /** Data permissions to set */
     dataPermissions?: DataPermissions;
@@ -818,7 +961,12 @@ export interface UpdateDataPermissionsResponse {
     dataCollection?: DataCollection;
 }
 export interface BulkGetDataCollectionsPageBySnapshotsRequest {
-    /** Ids of schema snapshot */
+    /**
+     * Ids of schema snapshot
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     snapshotIds?: string[];
     /** Pagination information. */
     paging?: Paging;
@@ -830,21 +978,33 @@ export interface BulkGetDataCollectionsPageBySnapshotsResponse {
     pagingMetadata?: PagingMetadataV2;
 }
 export interface SnapshotCollection {
-    /** snapshot to which collection belongs */
+    /**
+     * snapshot to which collection belongs
+     * @format GUID
+     */
     snapshotId?: string;
     /** snapshot collection */
     collection?: DataCollection;
-    /** snapshot of collection indexes */
+    /**
+     * snapshot of collection indexes
+     * @maxSize 100
+     */
     indexes?: Index[];
 }
 /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
 export interface Index {
-    /** Name of the index. */
+    /**
+     * Name of the index.
+     * @minLength 1
+     * @maxLength 128
+     */
     name?: string;
     /**
      * Fields for which the index is defined.
      *
      * Max: 3 fields (for a unique index: 1 field)
+     * @minSize 1
+     * @maxSize 3
      */
     fields?: IndexField[];
     /**
@@ -880,7 +1040,11 @@ export declare enum Order {
     DESC = "DESC"
 }
 export interface IndexField {
-    /** Path of the field to index. For example: `title` or `options.price`. */
+    /**
+     * Path of the field to index. For example: `title` or `options.price`.
+     * @minLength 1
+     * @maxLength 128
+     */
     path?: string;
     /**
      * Sort order for the index. Base on how the data is regularly queried.
@@ -911,45 +1075,72 @@ export interface Failure {
      * - `WDE0112`: Unknown error while building collection index.
      * - `WDE0113`: Duplicate key error while building collection index.
      * - `WDE0114`: Document too large while building collection index.
+     * @maxLength 7
      */
     code?: string;
-    /** Description of the failure. */
+    /**
+     * Description of the failure.
+     * @maxLength 1024
+     */
     description?: string;
     /**
      * ID of the data item that caused the failure.
      * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
+     * @maxLength 16000
      */
     itemId?: string | null;
 }
 export interface CreateDataCollectionsSnapshotRequest {
 }
 export interface CreateDataCollectionsSnapshotResponse {
-    /** created snapshot ID */
+    /**
+     * created snapshot ID
+     * @format GUID
+     */
     snapshotId?: string;
     /** data collections in snapshot */
     snapshotCollections?: DataCollection[];
 }
 export interface RestoreDataCollectionsFromSnapshotRequest {
-    /** snapshot ID to restore */
+    /**
+     * snapshot ID to restore
+     * @format GUID
+     */
     snapshotId?: string;
     /**
      * collection IDs to restore, if empty – all collections would be restored
+     * @maxSize 1000
+     * @maxLength 256
      * @deprecated
      * @replacedBy restoration_collections
      * @targetRemovalDate 2025-12-31
      */
     dataCollectionIds?: string[];
-    /** collection to restore, if empty – all collections would be restored */
+    /**
+     * collection to restore, if empty – all collections would be restored
+     * @maxSize 1000
+     */
     restorationCollections?: RestorationCollection[];
 }
 export interface Destination {
-    /** Collection id. */
+    /**
+     * Collection id.
+     * @minLength 1
+     * @maxLength 1000
+     */
     dataCollectionId?: string;
-    /** Display name. When not specified value is taken from the snapshot. */
+    /**
+     * Display name. When not specified value is taken from the snapshot.
+     * @maxLength 1000
+     */
     displayName?: string | null;
 }
 export interface RestorationCollection {
-    /** Collection ID to restore */
+    /**
+     * Collection ID to restore
+     * @minLength 1
+     * @maxLength 1000
+     */
     dataCollectionId?: string;
     /**
      * Destination where to restore the collection.
@@ -962,17 +1153,24 @@ export interface RestoreDataCollectionsFromSnapshotResponse {
     restoredCollections?: DataCollection[];
 }
 export interface DeleteDataCollectionsSnapshotRequest {
-    /** snapshot ID to delete */
+    /**
+     * snapshot ID to delete
+     * @format GUID
+     */
     snapshotId?: string;
 }
 export interface DeleteDataCollectionsSnapshotResponse {
 }
 export interface CreateMigratedCollectionsSnapshotRequest {
+    /** @format GUID */
     existingSnapshotId?: string;
+    /** @maxLength 255 */
     newNamespace?: string;
+    /** @maxLength 255 */
     existingNamespace?: string;
 }
 export interface CreateMigratedCollectionsSnapshotResponse {
+    /** @format GUID */
     snapshotId?: string;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -1048,9 +1246,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1058,26 +1262,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {