@wix/auto_sdk_data_collections 1.0.111 → 1.0.113

package/build/internal/cjs/meta.d.ts

@@ -104,7 +104,6 @@ interface DataCollection {
     dataPermissions?: DataPermissions;
     /**
      * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
-     * @internal
      * @readonly
      */
     allowedDataPermissions?: AllowedDataPermissions;
@@ -421,7 +420,6 @@ declare enum Type {
     /**
      * Secured media object with digital file metadata.
      * @documentationMaturity preview
-     * @internal
      */
     SECURED_MEDIA = "SECURED_MEDIA",
     /**
@@ -436,7 +434,7 @@ declare enum Type {
     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' | 'SLUG' | 'EMAIL' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
+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' | 'SLUG' | 'EMAIL' | 'SECURED_MEDIA' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
 interface TypeMetadata extends TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
@@ -448,110 +446,47 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
-    /**
-     * Metadata for a slug field.
-     * @internal
-     */
+    /** Metadata for a slug field. */
     slug?: Slug;
-    /**
-     * Metadata for TEXT.
-     * @internal
-     */
+    /** Metadata for TEXT. */
     text?: Text;
-    /**
-     * Metadata for NUMBER.
-     * @internal
-     */
+    /** Metadata for NUMBER. */
     number?: _Number;
-    /**
-     * Metadata for DATE.
-     * @internal
-     */
+    /** Metadata for DATE. */
     date?: _Date;
-    /**
-     * Metadata for DATETIME.
-     * @internal
-     */
+    /** Metadata for DATETIME. */
     datetime?: Datetime;
-    /**
-     * Metadata for IMAGE.
-     * @internal
-     */
+    /** Metadata for IMAGE. */
     image?: Image;
-    /**
-     * Metadata for BOOLEAN.
-     * @internal
-     */
+    /** Metadata for BOOLEAN. */
     boolean?: _Boolean;
-    /**
-     * Metadata for DOCUMENT.
-     * @internal
-     */
+    /** Metadata for DOCUMENT. */
     document?: Document;
-    /**
-     * Metadata for URL.
-     * @internal
-     */
+    /** Metadata for URL. */
     url?: Url;
-    /**
-     * Metadata for RICH_TEXT.
-     * @internal
-     */
+    /** Metadata for RICH_TEXT. */
     richText?: RichText;
-    /**
-     * Metadata for VIDEO.
-     * @internal
-     */
+    /** Metadata for VIDEO. */
     video?: Video;
-    /**
-     * Metadata for ARRAY_STRING.
-     * @internal
-     */
+    /** Metadata for ARRAY_STRING. */
     arrayString?: ArrayString;
-    /**
-     * Metadata for ARRAY_DOCUMENT.
-     * @internal
-     */
+    /** Metadata for ARRAY_DOCUMENT. */
     arrayDocument?: ArrayDocument;
-    /**
-     * Metadata for AUDIO.
-     * @internal
-     */
+    /** Metadata for AUDIO. */
     audio?: Audio;
-    /**
-     * Metadata for TIME.
-     * @internal
-     */
+    /** Metadata for TIME. */
     time?: Time;
-    /**
-     * Metadata for RICH_CONTENT.
-     * @internal
-     */
+    /** Metadata for RICH_CONTENT. */
     richContent?: RichContent;
-    /**
-     * Metadata for MEDIA_GALLERY.
-     * @internal
-     */
+    /** Metadata for MEDIA_GALLERY. */
     mediaGallery?: MediaGallery;
-    /**
-     * Metadata for ADDRESS.
-     * @internal
-     */
+    /** Metadata for ADDRESS. */
     address?: Address;
-    /**
-     * Metadata for EMAIL.
-     * @internal
-     */
+    /** Metadata for EMAIL. */
     email?: Email;
-    /**
-     * Metadata for LEGACY_COLOR.
-     * @internal
-     */
+    /** Metadata for LEGACY_COLOR. */
     legacyColor?: LegacyColor;
-    /**
-     * Metadata for MEDIA_IMAGE.
-     * @internal
-     */
+    /** Metadata for MEDIA_IMAGE. */
     mediaImage?: MediaImage;
 }
 /** @oneof */
@@ -566,110 +501,47 @@ interface TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
-    /**
-     * Metadata for a slug field.
-     * @internal
-     */
+    /** Metadata for a slug field. */
     slug?: Slug;
-    /**
-     * Metadata for TEXT.
-     * @internal
-     */
+    /** Metadata for TEXT. */
     text?: Text;
-    /**
-     * Metadata for NUMBER.
-     * @internal
-     */
+    /** Metadata for NUMBER. */
     number?: _Number;
-    /**
-     * Metadata for DATE.
-     * @internal
-     */
+    /** Metadata for DATE. */
     date?: _Date;
-    /**
-     * Metadata for DATETIME.
-     * @internal
-     */
+    /** Metadata for DATETIME. */
     datetime?: Datetime;
-    /**
-     * Metadata for IMAGE.
-     * @internal
-     */
+    /** Metadata for IMAGE. */
     image?: Image;
-    /**
-     * Metadata for BOOLEAN.
-     * @internal
-     */
+    /** Metadata for BOOLEAN. */
     boolean?: _Boolean;
-    /**
-     * Metadata for DOCUMENT.
-     * @internal
-     */
+    /** Metadata for DOCUMENT. */
     document?: Document;
-    /**
-     * Metadata for URL.
-     * @internal
-     */
+    /** Metadata for URL. */
     url?: Url;
-    /**
-     * Metadata for RICH_TEXT.
-     * @internal
-     */
+    /** Metadata for RICH_TEXT. */
     richText?: RichText;
-    /**
-     * Metadata for VIDEO.
-     * @internal
-     */
+    /** Metadata for VIDEO. */
     video?: Video;
-    /**
-     * Metadata for ARRAY_STRING.
-     * @internal
-     */
+    /** Metadata for ARRAY_STRING. */
     arrayString?: ArrayString;
-    /**
-     * Metadata for ARRAY_DOCUMENT.
-     * @internal
-     */
+    /** Metadata for ARRAY_DOCUMENT. */
     arrayDocument?: ArrayDocument;
-    /**
-     * Metadata for AUDIO.
-     * @internal
-     */
+    /** Metadata for AUDIO. */
     audio?: Audio;
-    /**
-     * Metadata for TIME.
-     * @internal
-     */
+    /** Metadata for TIME. */
     time?: Time;
-    /**
-     * Metadata for RICH_CONTENT.
-     * @internal
-     */
+    /** Metadata for RICH_CONTENT. */
     richContent?: RichContent;
-    /**
-     * Metadata for MEDIA_GALLERY.
-     * @internal
-     */
+    /** Metadata for MEDIA_GALLERY. */
     mediaGallery?: MediaGallery;
-    /**
-     * Metadata for ADDRESS.
-     * @internal
-     */
+    /** Metadata for ADDRESS. */
     address?: Address;
-    /**
-     * Metadata for EMAIL.
-     * @internal
-     */
+    /** Metadata for EMAIL. */
     email?: Email;
-    /**
-     * Metadata for LEGACY_COLOR.
-     * @internal
-     */
+    /** Metadata for LEGACY_COLOR. */
     legacyColor?: LegacyColor;
-    /**
-     * Metadata for MEDIA_IMAGE.
-     * @internal
-     */
+    /** Metadata for MEDIA_IMAGE. */
     mediaImage?: MediaImage;
 }
 interface FieldCapabilities {
@@ -805,10 +677,7 @@ interface _Object {
      * @maxSize 1000
      */
     fields?: ObjectField[];
-    /**
-     * Value assigned when a data item omits this field.
-     * @internal
-     */
+    /** Value assigned when a data item omits this field. */
     defaultValue?: Record<string, any> | null;
 }
 interface _Array {
@@ -816,17 +685,10 @@ interface _Array {
     elementType?: TypeWithLiterals;
     /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
     typeMetadata?: TypeMetadata;
-    /**
-     * Minimum permitted number of items in an array field.
-     * @internal
-     */
+    /** Minimum permitted number of items in an array field. */
     minSize?: number | null;
-    /**
-     * Maximum permitted number of items in an array field.
-     * @internal
-     */
+    /** Maximum permitted number of items in an array field. */
     maxSize?: number | null;
-    /** @internal */
     defaultValue?: any[];
 }
 interface PageLink {
@@ -837,10 +699,7 @@ interface PageLink {
      * @maxLength 1000
      */
     linkedRouterPage?: string | null;
-    /**
-     * Defines the type of the page link.
-     * @internal
-     */
+    /** Defines the type of the page link. */
     pageLinkType?: PageLinkTypeWithLiterals;
 }
 interface Slug {
@@ -850,17 +709,10 @@ interface Slug {
      * @maxLength 1000
      */
     pattern?: string;
-    /**
-     * Minimum permitted length for a string field.
-     * @internal
-     */
+    /** Minimum permitted length for a string field. */
     minLength?: number | null;
-    /**
-     * Maximum permitted length for a string field.
-     * @internal
-     */
+    /** Maximum permitted length for a string field. */
     maxLength?: number | null;
-    /** @internal */
     defaultValue?: string | null;
 }
 interface Text extends TextValidationOneOf {
@@ -1112,27 +964,15 @@ declare enum FieldPluginType {
     UNKNOWN = "UNKNOWN",
     /** CMS-related field attributes. */
     CMS = "CMS",
-    /**
-     * Marks a multi-reference field as a category field linking to a Category Group.
-     * @documentationMaturity preview
-     * @internal
-     */
+    /** Marks a multi-reference field as a category field linking to a Category Group. */
     CATEGORY_FIELD = "CATEGORY_FIELD",
-    /**
-     * Marks a back-reference field on Category Groups indicating a consumer relationship.
-     * @documentationMaturity preview
-     * @internal
-     */
+    /** Marks a back-reference field on Category Groups indicating a consumer relationship. */
     CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
-    /**
-     * Marks the auto-managed primary category single-reference field on a consumer collection.
-     * @documentationMaturity preview
-     * @internal
-     */
+    /** Marks the auto-managed primary category single-reference field on a consumer collection. */
     PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
 }
 /** @enumType */
-type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
+type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS' | 'CATEGORY_FIELD' | 'CATEGORY_CONSUMER' | 'PRIMARY_CATEGORY_FIELD';
 /** Options for the CMS plugin. */
 interface CmsOptions {
     /**
@@ -1226,15 +1066,9 @@ interface Plugin extends PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
-    /**
-     * Options for the Catalog plugin.
-     * @internal
-     */
+    /** Options for the Catalog plugin. */
     catalogOptions?: CatalogOptions;
-    /**
-     * Options for the Draft Items plugin.
-     * @internal
-     */
+    /** Options for the Draft Items plugin. */
     draftItemsOptions?: DraftItemsPluginOptions;
     /** Plugin type. */
     type?: PluginTypeWithLiterals;
@@ -1256,15 +1090,9 @@ interface PluginOptionsOneOf {
     editablePageLinkOptions?: PageLinkPluginOptions;
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
-    /**
-     * Options for the Catalog plugin.
-     * @internal
-     */
+    /** Options for the Catalog plugin. */
     catalogOptions?: CatalogOptions;
-    /**
-     * Options for the Draft Items plugin.
-     * @internal
-     */
+    /** Options for the Draft Items plugin. */
     draftItemsOptions?: DraftItemsPluginOptions;
 }
 declare enum Status {
@@ -1320,20 +1148,17 @@ 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;
     /**
      * Access level required to view draft items. Managing drafts also grants viewing.
      * If omitted, inherits manage_drafts for compatibility.
-     * @internal
      */
     viewDrafts?: AccessLevelWithLiterals;
 }
@@ -1362,27 +1187,15 @@ declare enum PluginType {
     EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
     /** CMS-specific collection properties. */
     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
-     */
+    /** 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. */
     CATALOG = "CATALOG",
-    /**
-     * Marks the collection as a Category Group for categorization features.
-     * @documentationMaturity preview
-     * @internal
-     */
+    /** Marks the collection as a Category Group for categorization features. */
     CATEGORIES = "CATEGORIES",
-    /**
-     * Enables the draft items collection: safe draft editing with explicit publish step.
-     * @documentationMaturity preview
-     * @internal
-     */
+    /** Enables the draft items collection: safe draft editing with explicit publish step. */
     DRAFT_ITEMS = "DRAFT_ITEMS"
 }
 /** @enumType */
-type PluginTypeWithLiterals = PluginType | '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' | 'CATALOG' | 'CATEGORIES' | 'DRAFT_ITEMS';
 interface PublishPluginOptions {
     /**
      * Publication status assigned to items that don't specify one.
@@ -1607,14 +1420,10 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
      * @readonly
      */
     publishedCollectionId?: string;
-    /**
-     * Access levels required to view and manage drafts and change publication status.
-     * @internal
-     */
+    /** Access levels required to view and manage drafts and change publication status. */
     draftPermissions?: DraftPermissions;
     /**
      * Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
-     * @internal
      * @readonly
      */
     allowedPermissions?: AllowedDraftPermissions;
@@ -1622,7 +1431,6 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
      * Whether writes to the published collection are allowed while the Draft Items plugin is enabled.
      * Defaults to `false` for newly created collections and newly added plugins.
      * Existing schemas that predate this field return `true` for backwards compatibility.
-     * @internal
      */
     allowWritesToPublishedCollection?: boolean;
 }
@@ -1811,10 +1619,7 @@ interface GetDataCollectionRequest {
      * @internal
      */
     includeDeletedFields?: boolean;
-    /**
-     * If set allowed for caller data permissions would be included in the response
-     * @internal
-     */
+    /** If set allowed for caller data permissions would be included in the response */
     includeAllowedDataPermissions?: boolean;
     /**
      * Segment: PUBLIC or DEV.
@@ -1871,10 +1676,7 @@ interface ListDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
-    /**
-     * If set allowed for caller data permissions would be included in the response
-     * @internal
-     */
+    /** If set allowed for caller data permissions would be included in the response */
     includeAllowedDataPermissions?: boolean;
     /**
      * Segment: PUBLIC or DEV.
@@ -1972,10 +1774,7 @@ interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
-    /**
-     * If set allowed for caller data permissions would be included in the response
-     * @internal
-     */
+    /** If set allowed for caller data permissions would be included in the response */
     includeAllowedDataPermissions?: boolean;
     /**
      * Segment: PUBLIC or DEV.