@wix/auto_sdk_data_collections 1.0.90 → 1.0.92

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

@@ -99,6 +99,12 @@ interface DataCollection {
      * @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
@@ -254,6 +260,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.
      *
@@ -277,6 +288,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
@@ -376,6 +393,11 @@ 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
+     */
+    SLUG = "SLUG",
     /**
      * Email.
      * @documentationMaturity preview
@@ -390,18 +412,16 @@ declare enum Type {
     /**
      * 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';
+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';
 interface TypeMetadata extends TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
@@ -413,6 +433,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 {
@@ -426,6 +546,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 {
     /**
@@ -551,12 +771,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;
@@ -565,6 +799,11 @@ interface PageLink {
      * @maxLength 1000
      */
     linkedRouterPage?: string | null;
+    /**
+     * Defines the type of the page link.
+     * @internal
+     */
+    pageLinkType?: PageLinkTypeWithLiterals;
 }
 interface Slug {
     /**
@@ -572,6 +811,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;
@@ -783,7 +1034,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';
@@ -880,6 +1149,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;
 }
@@ -900,6 +1179,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",
@@ -948,6 +1237,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. */
@@ -971,7 +1274,25 @@ 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';
@@ -1157,6 +1478,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 {
@@ -1312,6 +1641,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.
@@ -1320,11 +1656,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
@@ -1343,6 +1692,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 {
     /**
@@ -1366,6 +1721,12 @@ interface ListDataCollectionsRequest {
      * @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
@@ -1373,6 +1734,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 {
     /**
@@ -1446,6 +1815,12 @@ interface BulkGetDataCollectionsRequest {
      * @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
@@ -1513,6 +1888,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. */
@@ -1780,6 +2165,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. */
@@ -1959,6 +2351,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
@@ -2550,6 +2949,12 @@ interface PatchDataCollection {
      * @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

package/build/internal/cjs/index.typings.js

@@ -2034,6 +2034,7 @@ var Type = /* @__PURE__ */ ((Type2) => {
   Type2["LEGACY_IMAGE"] = "LEGACY_IMAGE";
   Type2["LEGACY_COLOR"] = "LEGACY_COLOR";
   Type2["LEGACY_EXTERNAL_VIDEO"] = "LEGACY_EXTERNAL_VIDEO";
+  Type2["SLUG"] = "SLUG";
   Type2["EMAIL"] = "EMAIL";
   Type2["SECURED_MEDIA"] = "SECURED_MEDIA";
   Type2["MEDIA_IMAGE"] = "MEDIA_IMAGE";
@@ -2064,6 +2065,9 @@ var PageLinkType = /* @__PURE__ */ ((PageLinkType2) => {
 var FieldPluginType = /* @__PURE__ */ ((FieldPluginType2) => {
   FieldPluginType2["UNKNOWN"] = "UNKNOWN";
   FieldPluginType2["CMS"] = "CMS";
+  FieldPluginType2["CATEGORY_FIELD"] = "CATEGORY_FIELD";
+  FieldPluginType2["CATEGORY_CONSUMER"] = "CATEGORY_CONSUMER";
+  FieldPluginType2["PRIMARY_CATEGORY_FIELD"] = "PRIMARY_CATEGORY_FIELD";
   return FieldPluginType2;
 })(FieldPluginType || {});
 var Permission = /* @__PURE__ */ ((Permission2) => {
@@ -2110,6 +2114,9 @@ var PluginType = /* @__PURE__ */ ((PluginType2) => {
   PluginType2["SHARED"] = "SHARED";
   PluginType2["EDITABLE_PAGE_LINK"] = "EDITABLE_PAGE_LINK";
   PluginType2["CMS"] = "CMS";
+  PluginType2["CATALOG"] = "CATALOG";
+  PluginType2["CATEGORIES"] = "CATEGORIES";
+  PluginType2["DRAFT_ITEMS"] = "DRAFT_ITEMS";
   return PluginType2;
 })(PluginType || {});
 var PagingMode = /* @__PURE__ */ ((PagingMode2) => {