@wix/auto_sdk_data_collections 1.0.54 → 1.0.56

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

@@ -279,6 +279,23 @@ interface FieldRangeValidationsOneOf {
     /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */
     arraySizeRange?: ArraySizeRange;
 }
+interface TextValidation {
+    /** Minimum permitted length for a text field. */
+    minLength?: number | null;
+    /** Maximum permitted length for a text field. */
+    maxLength?: number | null;
+    /** Custom regex pattern for string validation. */
+    pattern?: string | null;
+}
+interface EnumValues {
+    /**
+     * Allowed enum values for string fields.
+     * @minSize 1
+     * @maxSize 512
+     * @maxLength 1000
+     */
+    values?: string[];
+}
 declare enum Type {
     UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
     /** Plain-text string. */
@@ -523,6 +540,149 @@ interface Slug {
      */
     pattern?: string;
 }
+interface Text extends TextValidationOneOf {
+    textValidation?: TextValidation;
+    enumValues?: EnumValues;
+    defaultValue?: string | null;
+}
+/** @oneof */
+interface TextValidationOneOf {
+    textValidation?: TextValidation;
+    enumValues?: EnumValues;
+}
+interface _Number {
+    defaultValue?: number | null;
+    /** Minimum permitted value for a numerical field. */
+    min?: number | null;
+    /** Maximum permitted value for a numerical field. */
+    max?: number | null;
+}
+interface _Date extends _DateDefaultValueOneOf, _DateMinDateOneOf, _DateMaxDateOneOf {
+    defaultValueFixed?: Date | null;
+    defaultValueOffsetFromNowInDays?: number | null;
+    minDateFixed?: Date | null;
+    minValueOffsetFromNowInDays?: number | null;
+    maxDateFixed?: Date | null;
+    maxValueOffsetFromNowInDays?: number | null;
+}
+/** @oneof */
+interface _DateDefaultValueOneOf {
+    defaultValueFixed?: Date | null;
+    defaultValueOffsetFromNowInDays?: number | null;
+}
+/** @oneof */
+interface _DateMinDateOneOf {
+    minDateFixed?: Date | null;
+    minValueOffsetFromNowInDays?: number | null;
+}
+/** @oneof */
+interface _DateMaxDateOneOf {
+    maxDateFixed?: Date | null;
+    maxValueOffsetFromNowInDays?: number | null;
+}
+interface Datetime extends DatetimeDefaultValueOneOf, DatetimeMinDateOneOf, DatetimeMaxDateOneOf {
+    defaultValueFixed?: Date | null;
+    defaultValueOffsetFromNowInSeconds?: number | null;
+    minDateFixed?: Date | null;
+    minDateOffsetFromNowInDays?: number | null;
+    maxDateFixed?: Date | null;
+    maxDateOffsetFromNowInDays?: number | null;
+}
+/** @oneof */
+interface DatetimeDefaultValueOneOf {
+    defaultValueFixed?: Date | null;
+    defaultValueOffsetFromNowInSeconds?: number | null;
+}
+/** @oneof */
+interface DatetimeMinDateOneOf {
+    minDateFixed?: Date | null;
+    minDateOffsetFromNowInDays?: number | null;
+}
+/** @oneof */
+interface DatetimeMaxDateOneOf {
+    maxDateFixed?: Date | null;
+    maxDateOffsetFromNowInDays?: number | null;
+}
+interface Image {
+    defaultValue?: string | null;
+}
+interface _Boolean {
+    defaultValue?: boolean | null;
+}
+interface Document {
+    defaultValue?: string | null;
+}
+interface Url {
+    /** @format WEB_URL */
+    defaultValue?: string | null;
+    textValidation?: TextValidation;
+}
+interface RichText {
+    defaultValue?: string | null;
+    /** Minimum permitted length for a string field. */
+    minLength?: number | null;
+    /** Maximum permitted length for a string field. */
+    maxLength?: number | null;
+}
+interface Video {
+    defaultValue?: string | null;
+}
+interface ArrayString {
+    defaultValue?: string[] | null;
+    /** Minimum permitted number of items in an array field. */
+    minSize?: number | null;
+    /** Maximum permitted number of items in an array field. */
+    maxSize?: number | null;
+    /** Minimum permitted length for a each item. */
+    minLengthForItem?: number | null;
+    /** Maximum permitted length for a each item. */
+    maxLengthForItem?: number | null;
+}
+interface ArrayDocument {
+    defaultValue?: string[] | null;
+    /** Minimum permitted number of items in an array field. */
+    minSize?: number | null;
+    /** Maximum permitted number of items in an array field. */
+    maxSize?: number | null;
+}
+interface Audio {
+    defaultValue?: string | null;
+}
+interface Time {
+    /**
+     * Time value in format: hh:mm (e.g., "00:00", "09:30").
+     * @minLength 5
+     * @maxLength 5
+     */
+    defaultValue?: string | null;
+    /**
+     * Minimum permitted time-of-day (inclusive).
+     * Time value in format: hh:mm (e.g., "00:00", "09:30").
+     * @minLength 5
+     * @maxLength 5
+     */
+    minTime?: string | null;
+    /**
+     * Maximum permitted time-of-day (inclusive).
+     * Time value in format: hh:mm (e.g., "23:59", "17:00").
+     * @minLength 5
+     * @maxLength 5
+     */
+    maxTime?: string | null;
+}
+interface RichContent {
+    defaultValue?: Record<string, any> | null;
+}
+interface MediaGallery {
+    defaultValue?: Record<string, any>[] | null;
+}
+interface Address {
+    defaultValue?: Record<string, any> | null;
+}
+interface Email {
+    /** @format EMAIL */
+    defaultValue?: string | null;
+}
 interface NumberRange {
     /**
      * Minimum permitted value for a numerical field.
@@ -2082,4 +2242,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 AccountInfo, 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, restoreDataCollection, updateDataCollection, updateDataCollectionField };
+export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, 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 Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, 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 Document, type DomainEvent, type DomainEventBodyOneOf, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, 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 Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, 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, type RichContent, type RichText, 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 Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, restoreDataCollection, updateDataCollection, updateDataCollectionField };