@wix/auto_sdk_data_collections 1.0.90 → 1.0.91

package/build/internal/es/meta.d.mts

@@ -89,6 +89,29 @@ interface DataCollection {
      * @readonly
      */
     updatedDate?: Date | null;
+    /**
+     * [Permissions](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/introduction#permissions) required to access and modify collection items, defined by the lowest access level required to perform each action.
+     * @internal
+     */
+    dataPermissions?: DataPermissions;
+    /**
+     * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
+     * @internal
+     * @readonly
+     */
+    allowedDataPermissions?: AllowedDataPermissions;
+    /**
+     * Strict mode the collection fields validation.
+     * When enabled, strict mode enforces all field validations during data operations.
+     * @internal
+     */
+    strictMode?: boolean | null;
+    /**
+     * Free-text description of the collection's purpose and contents.
+     * @internal
+     * @maxLength 4000
+     */
+    description?: string | null;
 }
 declare enum CollectionType {
     /** User-created collection. */
@@ -136,6 +159,11 @@ interface CollectionCapabilities {
     collectionOperations?: CollectionOperationWithLiterals[];
     /** Maximum number of indexes for the collection. */
     indexLimits?: IndexLimits;
+    /**
+     * Maximum number of indexes for the collection.
+     * @internal
+     */
+    indexQuotaLimits?: IndexQuotaLimits;
 }
 declare enum DataOperation {
     AGGREGATE = "AGGREGATE",
@@ -233,6 +261,11 @@ interface Field extends FieldRangeValidationsOneOf {
      * @maxLength 16000
      */
     description?: string | null;
+    /**
+     * @internal
+     * @maxLength 100
+     */
+    plugin?: string | null;
     /**
      * Whether the field is read-only. A read-only field can't be changed.
      *
@@ -256,6 +289,12 @@ interface Field extends FieldRangeValidationsOneOf {
      * @maxSize 100
      */
     plugins?: FieldPlugin[];
+    /**
+     * Whether the field is deleted. Returned only when `include_deleted_fields = true`.
+     * @internal
+     * @readonly
+     */
+    deleted?: boolean | null;
     /**
      * This indicates that this fields is conditional and is not retrieved by default.
      * @readonly
@@ -355,11 +394,35 @@ declare enum Type {
     LEGACY_COLOR = "LEGACY_COLOR",
     /** Deprecated type that might appear in legacy collections. */
     LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO",
+    /**
+     * SLUG type used for dynamic page URLs.
+     * @documentationMaturity preview
+     * @internal
+     */
+    SLUG = "SLUG",
     /**
      * Email.
      * @documentationMaturity preview
      */
-    EMAIL = "EMAIL"
+    EMAIL = "EMAIL",
+    /**
+     * Secured media object with digital file metadata.
+     * @documentationMaturity preview
+     * @internal
+     */
+    SECURED_MEDIA = "SECURED_MEDIA",
+    /**
+     * Media image object.
+     * @documentationMaturity preview
+     * @internal
+     */
+    MEDIA_IMAGE = "MEDIA_IMAGE",
+    /**
+     * Media vector art object.
+     * @documentationMaturity preview
+     * @internal
+     */
+    MEDIA_VECTOR_ART = "MEDIA_VECTOR_ART"
 }
 /** @enumType */
 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' | 'EMAIL';
@@ -374,6 +437,106 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /**
+     * Metadata for a slug field.
+     * @internal
+     */
+    slug?: Slug;
+    /**
+     * Metadata for TEXT.
+     * @internal
+     */
+    text?: Text;
+    /**
+     * Metadata for NUMBER.
+     * @internal
+     */
+    number?: _Number;
+    /**
+     * Metadata for DATE.
+     * @internal
+     */
+    date?: _Date;
+    /**
+     * Metadata for DATETIME.
+     * @internal
+     */
+    datetime?: Datetime;
+    /**
+     * Metadata for IMAGE.
+     * @internal
+     */
+    image?: Image;
+    /**
+     * Metadata for BOOLEAN.
+     * @internal
+     */
+    boolean?: _Boolean;
+    /**
+     * Metadata for DOCUMENT.
+     * @internal
+     */
+    document?: Document;
+    /**
+     * Metadata for URL.
+     * @internal
+     */
+    url?: Url;
+    /**
+     * Metadata for RICH_TEXT.
+     * @internal
+     */
+    richText?: RichText;
+    /**
+     * Metadata for VIDEO.
+     * @internal
+     */
+    video?: Video;
+    /**
+     * Metadata for ARRAY_STRING.
+     * @internal
+     */
+    arrayString?: ArrayString;
+    /**
+     * Metadata for ARRAY_DOCUMENT.
+     * @internal
+     */
+    arrayDocument?: ArrayDocument;
+    /**
+     * Metadata for AUDIO.
+     * @internal
+     */
+    audio?: Audio;
+    /**
+     * Metadata for TIME.
+     * @internal
+     */
+    time?: Time;
+    /**
+     * Metadata for RICH_CONTENT.
+     * @internal
+     */
+    richContent?: RichContent;
+    /**
+     * Metadata for MEDIA_GALLERY.
+     * @internal
+     */
+    mediaGallery?: MediaGallery;
+    /**
+     * Metadata for ADDRESS.
+     * @internal
+     */
+    address?: Address;
+    /**
+     * Metadata for EMAIL.
+     * @internal
+     */
+    email?: Email;
+    /**
+     * Metadata for LEGACY_COLOR.
+     * @internal
+     */
+    legacyColor?: LegacyColor;
 }
 /** @oneof */
 interface TypeMetadataMetadataOneOf {
@@ -387,6 +550,106 @@ interface TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /**
+     * Metadata for a slug field.
+     * @internal
+     */
+    slug?: Slug;
+    /**
+     * Metadata for TEXT.
+     * @internal
+     */
+    text?: Text;
+    /**
+     * Metadata for NUMBER.
+     * @internal
+     */
+    number?: _Number;
+    /**
+     * Metadata for DATE.
+     * @internal
+     */
+    date?: _Date;
+    /**
+     * Metadata for DATETIME.
+     * @internal
+     */
+    datetime?: Datetime;
+    /**
+     * Metadata for IMAGE.
+     * @internal
+     */
+    image?: Image;
+    /**
+     * Metadata for BOOLEAN.
+     * @internal
+     */
+    boolean?: _Boolean;
+    /**
+     * Metadata for DOCUMENT.
+     * @internal
+     */
+    document?: Document;
+    /**
+     * Metadata for URL.
+     * @internal
+     */
+    url?: Url;
+    /**
+     * Metadata for RICH_TEXT.
+     * @internal
+     */
+    richText?: RichText;
+    /**
+     * Metadata for VIDEO.
+     * @internal
+     */
+    video?: Video;
+    /**
+     * Metadata for ARRAY_STRING.
+     * @internal
+     */
+    arrayString?: ArrayString;
+    /**
+     * Metadata for ARRAY_DOCUMENT.
+     * @internal
+     */
+    arrayDocument?: ArrayDocument;
+    /**
+     * Metadata for AUDIO.
+     * @internal
+     */
+    audio?: Audio;
+    /**
+     * Metadata for TIME.
+     * @internal
+     */
+    time?: Time;
+    /**
+     * Metadata for RICH_CONTENT.
+     * @internal
+     */
+    richContent?: RichContent;
+    /**
+     * Metadata for MEDIA_GALLERY.
+     * @internal
+     */
+    mediaGallery?: MediaGallery;
+    /**
+     * Metadata for ADDRESS.
+     * @internal
+     */
+    address?: Address;
+    /**
+     * Metadata for EMAIL.
+     * @internal
+     */
+    email?: Email;
+    /**
+     * Metadata for LEGACY_COLOR.
+     * @internal
+     */
+    legacyColor?: LegacyColor;
 }
 interface FieldCapabilities {
     /**
@@ -512,12 +775,26 @@ interface _Object {
      * @maxSize 1000
      */
     fields?: ObjectField[];
+    /** @internal */
+    defaultValue?: Record<string, any> | null;
 }
 interface _Array {
     /** Element's data type. */
     elementType?: TypeWithLiterals;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata;
+    /**
+     * Minimum permitted number of items in an array field.
+     * @internal
+     */
+    minSize?: number | null;
+    /**
+     * Maximum permitted number of items in an array field.
+     * @internal
+     */
+    maxSize?: number | null;
+    /** @internal */
+    defaultValue?: any[];
 }
 interface PageLink {
     calculator?: Calculator;
@@ -526,6 +803,11 @@ interface PageLink {
      * @maxLength 1000
      */
     linkedRouterPage?: string | null;
+    /**
+     * Defines the type of the page link.
+     * @internal
+     */
+    pageLinkType?: PageLinkTypeWithLiterals;
 }
 interface Slug {
     /**
@@ -533,6 +815,18 @@ interface Slug {
      * @maxLength 1000
      */
     pattern?: string;
+    /**
+     * Minimum permitted length for a string field.
+     * @internal
+     */
+    minLength?: number | null;
+    /**
+     * Maximum permitted length for a string field.
+     * @internal
+     */
+    maxLength?: number | null;
+    /** @internal */
+    defaultValue?: string | null;
 }
 interface Text extends TextValidationOneOf {
     textValidation?: TextValidation;
@@ -744,7 +1038,25 @@ declare enum FieldPluginType {
     /** Uknown plugin type. */
     UNKNOWN = "UNKNOWN",
     /** CMS-related field attributes */
-    CMS = "CMS"
+    CMS = "CMS",
+    /**
+     * Marks a multi-reference field as a category field linking to a Category Group.
+     * @documentationMaturity preview
+     * @internal
+     */
+    CATEGORY_FIELD = "CATEGORY_FIELD",
+    /**
+     * Marks a back-reference field on Category Groups indicating a consumer relationship.
+     * @documentationMaturity preview
+     * @internal
+     */
+    CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
+    /**
+     * Marks the auto-managed primary category single-reference field on a consumer collection.
+     * @documentationMaturity preview
+     * @internal
+     */
+    PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
 }
 /** @enumType */
 type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
@@ -841,6 +1153,16 @@ interface Plugin extends PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
+    /**
+     * Options for the Catalog plugin.
+     * @internal
+     */
+    catalogOptions?: CatalogOptions;
+    /**
+     * Options for the Draft Items plugin.
+     * @internal
+     */
+    draftItemsOptions?: DraftItemsPluginOptions;
     /** Plugin type. */
     type?: PluginTypeWithLiterals;
 }
@@ -861,6 +1183,16 @@ interface PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
+    /**
+     * Options for the Catalog plugin.
+     * @internal
+     */
+    catalogOptions?: CatalogOptions;
+    /**
+     * Options for the Draft Items plugin.
+     * @internal
+     */
+    draftItemsOptions?: DraftItemsPluginOptions;
 }
 declare enum Status {
     PUBLISHED = "PUBLISHED",
@@ -909,6 +1241,20 @@ declare enum AccessLevel {
 /** @enumType */
 type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
 interface DraftPermissions {
+    /**
+     * Access level required to view/edit/remove items from the drafts collection.
+     * Can be set to one of CMS_EDITOR, PRIVILEGED
+     * Default: `CMS_EDITOR`
+     * @internal
+     */
+    manageDrafts?: AccessLevelWithLiterals;
+    /**
+     * Access level required to publish draft items and unpublish published items.
+     * Can be set to one of CMS_EDITOR, PRIVILEGED
+     * Default: `CMS_EDITOR`
+     * @internal
+     */
+    managePublishStatus?: AccessLevelWithLiterals;
 }
 interface AllowedDraftPermissions {
     /** If manage_drafts is permitted for the caller. */
@@ -932,13 +1278,37 @@ declare enum PluginType {
     /** Indicates that page link fields are persisted and can be updated. */
     EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
     /** CMS-specific collection properties. */
-    CMS = "CMS"
+    CMS = "CMS",
+    /**
+     * Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog.
+     * @documentationMaturity preview
+     * @internal
+     */
+    CATALOG = "CATALOG",
+    /**
+     * Marks the collection as a Category Group for categorization features.
+     * @documentationMaturity preview
+     * @internal
+     */
+    CATEGORIES = "CATEGORIES",
+    /**
+     * Enables the draft items collection: safe draft editing with explicit publish step.
+     * @documentationMaturity preview
+     * @internal
+     */
+    DRAFT_ITEMS = "DRAFT_ITEMS"
 }
 /** @enumType */
 type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
 interface PublishPluginOptions {
     /** Default status. */
     defaultStatus?: StatusWithLiterals;
+    /**
+     * Server-managed lifecycle status.
+     * @internal
+     * @readonly
+     */
+    lifecycleStatus?: LifecycleStatusWithLiterals;
 }
 interface SingleItemPluginOptions {
     /**
@@ -1112,6 +1482,14 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
      * @readonly
      */
     publishedCollectionId?: string;
+    /** @internal */
+    draftPermissions?: DraftPermissions;
+    /**
+     * Actual draft management operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`.
+     * @internal
+     * @readonly
+     */
+    allowedPermissions?: AllowedDraftPermissions;
 }
 /** @oneof */
 interface DraftItemsPluginOptionsPairedCollectionOneOf {
@@ -1267,6 +1645,13 @@ interface GetDataCollectionRequest {
      * @maxLength 256
      */
     dataCollectionId: string;
+    /**
+     * Whether to return all collections referenced by the requested collection.
+     *
+     * Default: `false`
+     * @internal
+     */
+    includeReferencedCollections?: boolean;
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1275,6 +1660,24 @@ interface GetDataCollectionRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * Whether to return deleted fields.
+     *
+     * Default: `false`
+     * @internal
+     */
+    includeDeletedFields?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
+    /**
+     * Segment: PUBLIC or DEV.
+     * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
+     * @internal
+     */
+    segment?: SegmentWithLiterals;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -1293,6 +1696,12 @@ type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
 interface GetDataCollectionResponse {
     /** Details of the collection requested. */
     collection?: DataCollection;
+    /**
+     * Details of collections referenced by the collection requested.
+     * Only populated when `includeReferencedCollections` is `true` in the request.
+     * @internal
+     */
+    referencedCollections?: DataCollection[];
 }
 interface ListDataCollectionsRequest {
     /**
@@ -1311,6 +1720,17 @@ interface ListDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
+    /**
+     * Segment: PUBLIC or DEV.
+     * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
+     * @internal
+     */
+    segment?: SegmentWithLiterals;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -1318,6 +1738,14 @@ interface ListDataCollectionsRequest {
      * @maxLength 128
      */
     fields?: string[];
+    /**
+     * Collection types to filter by.
+     * If not specified, all collection types are returned.
+     * If specified, only collections of the given types are returned.
+     * @internal
+     * @maxSize 10
+     */
+    collectionTypes?: CollectionTypeWithLiterals[];
 }
 interface Sorting {
     /**
@@ -1386,6 +1814,17 @@ interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
+    /**
+     * Segment: PUBLIC or DEV.
+     * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
+     * @internal
+     */
+    segment?: SegmentWithLiterals;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -1453,6 +1892,16 @@ interface RestoreDataCollectionResponse {
 interface PatchDataCollectionRequest {
     /** Data collection to update. */
     dataCollection: DataCollection;
+    /**
+     * Field mask specifying which properties to update.
+     * Supported properties: `displayName`, `displayField`, `permissions`.
+     * Attempting to update unsupported properties results in an error.
+     * To update `fields` use [Create Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection-field),
+     * [Update Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/update-data-collection-field),
+     * or [Delete Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/delete-data-collection-field).
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface PatchDataCollectionResponse {
     /** Updated data collection. */
@@ -1720,6 +2169,13 @@ interface PatchDataCollectionFieldRequest {
     dataCollectionId: string;
     /** Field to update. */
     field: Field;
+    /**
+     * Field mask specifying which field properties to update.
+     * Supported properties: `displayName`, `type`, `typeMetadata`, `encrypted`, `description`.
+     * Attempting to update `key` or other unsupported properties results in an error.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface PatchDataCollectionFieldResponse {
     /** Updated data collection. */
@@ -1899,6 +2355,13 @@ interface Failure {
      * @maxLength 7
      */
     code?: string;
+    /**
+     * Broad error code.
+     * - `WD_UNKNOWN_ERROR`: Unknown error.
+     * @internal
+     * @maxLength 64
+     */
+    broadCode?: string;
     /**
      * Description of the failure.
      * @maxLength 1024
@@ -2091,8 +2554,18 @@ interface DomainEventBodyOneOf {
 }
 interface EntityCreatedEvent {
     entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface RestoreInfo {
     deletedDate?: Date | null;
@@ -2104,10 +2577,42 @@ interface EntityUpdatedEvent {
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
     currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
     /** Entity that was deleted. */
     deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface ActionEvent {
     bodyAsJson?: string;