@wix/auto_sdk_data_collections 1.0.112 → 1.0.113

package/build/cjs/meta.d.ts

@@ -97,6 +97,11 @@ interface DataCollection {
      * @readonly
      */
     updatedDate?: Date | null;
+    /**
+     * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
+     * @readonly
+     */
+    allowedDataPermissions?: AllowedDataPermissions;
     /**
      * Deprecation metadata for this collection. App collections set this metadata to direct users to a replacement collection.
      * @readonly
@@ -378,6 +383,11 @@ declare enum Type {
      * @documentationMaturity preview
      */
     EMAIL = "EMAIL",
+    /**
+     * Secured media object with digital file metadata.
+     * @documentationMaturity preview
+     */
+    SECURED_MEDIA = "SECURED_MEDIA",
     /**
      * Media image object.
      * @documentationMaturity preview
@@ -390,7 +400,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;
@@ -402,6 +412,48 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /** Metadata for a slug field. */
+    slug?: Slug;
+    /** Metadata for TEXT. */
+    text?: Text;
+    /** Metadata for NUMBER. */
+    number?: _Number;
+    /** Metadata for DATE. */
+    date?: _Date;
+    /** Metadata for DATETIME. */
+    datetime?: Datetime;
+    /** Metadata for IMAGE. */
+    image?: Image;
+    /** Metadata for BOOLEAN. */
+    boolean?: _Boolean;
+    /** Metadata for DOCUMENT. */
+    document?: Document;
+    /** Metadata for URL. */
+    url?: Url;
+    /** Metadata for RICH_TEXT. */
+    richText?: RichText;
+    /** Metadata for VIDEO. */
+    video?: Video;
+    /** Metadata for ARRAY_STRING. */
+    arrayString?: ArrayString;
+    /** Metadata for ARRAY_DOCUMENT. */
+    arrayDocument?: ArrayDocument;
+    /** Metadata for AUDIO. */
+    audio?: Audio;
+    /** Metadata for TIME. */
+    time?: Time;
+    /** Metadata for RICH_CONTENT. */
+    richContent?: RichContent;
+    /** Metadata for MEDIA_GALLERY. */
+    mediaGallery?: MediaGallery;
+    /** Metadata for ADDRESS. */
+    address?: Address;
+    /** Metadata for EMAIL. */
+    email?: Email;
+    /** Metadata for LEGACY_COLOR. */
+    legacyColor?: LegacyColor;
+    /** Metadata for MEDIA_IMAGE. */
+    mediaImage?: MediaImage;
 }
 /** @oneof */
 interface TypeMetadataMetadataOneOf {
@@ -415,6 +467,48 @@ interface TypeMetadataMetadataOneOf {
     array?: _Array;
     /** Metadata for a page link field. */
     pageLink?: PageLink;
+    /** Metadata for a slug field. */
+    slug?: Slug;
+    /** Metadata for TEXT. */
+    text?: Text;
+    /** Metadata for NUMBER. */
+    number?: _Number;
+    /** Metadata for DATE. */
+    date?: _Date;
+    /** Metadata for DATETIME. */
+    datetime?: Datetime;
+    /** Metadata for IMAGE. */
+    image?: Image;
+    /** Metadata for BOOLEAN. */
+    boolean?: _Boolean;
+    /** Metadata for DOCUMENT. */
+    document?: Document;
+    /** Metadata for URL. */
+    url?: Url;
+    /** Metadata for RICH_TEXT. */
+    richText?: RichText;
+    /** Metadata for VIDEO. */
+    video?: Video;
+    /** Metadata for ARRAY_STRING. */
+    arrayString?: ArrayString;
+    /** Metadata for ARRAY_DOCUMENT. */
+    arrayDocument?: ArrayDocument;
+    /** Metadata for AUDIO. */
+    audio?: Audio;
+    /** Metadata for TIME. */
+    time?: Time;
+    /** Metadata for RICH_CONTENT. */
+    richContent?: RichContent;
+    /** Metadata for MEDIA_GALLERY. */
+    mediaGallery?: MediaGallery;
+    /** Metadata for ADDRESS. */
+    address?: Address;
+    /** Metadata for EMAIL. */
+    email?: Email;
+    /** Metadata for LEGACY_COLOR. */
+    legacyColor?: LegacyColor;
+    /** Metadata for MEDIA_IMAGE. */
+    mediaImage?: MediaImage;
 }
 interface FieldCapabilities {
     /**
@@ -549,12 +643,19 @@ interface _Object {
      * @maxSize 1000
      */
     fields?: ObjectField[];
+    /** Value assigned when a data item omits this field. */
+    defaultValue?: Record<string, any> | null;
 }
 interface _Array {
     /** Element's data type. */
     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. */
+    minSize?: number | null;
+    /** Maximum permitted number of items in an array field. */
+    maxSize?: number | null;
+    defaultValue?: any[];
 }
 interface PageLink {
     /** Calculation pattern used to generate the page link. Required for page link fields. */
@@ -564,6 +665,8 @@ interface PageLink {
      * @maxLength 1000
      */
     linkedRouterPage?: string | null;
+    /** Defines the type of the page link. */
+    pageLinkType?: PageLinkTypeWithLiterals;
 }
 interface Slug {
     /**
@@ -572,6 +675,11 @@ interface Slug {
      * @maxLength 1000
      */
     pattern?: string;
+    /** Minimum permitted length for a string field. */
+    minLength?: number | null;
+    /** Maximum permitted length for a string field. */
+    maxLength?: number | null;
+    defaultValue?: string | null;
 }
 interface Text extends TextValidationOneOf {
     /** Length and pattern constraints for the text value. */
@@ -1457,6 +1565,8 @@ interface GetDataCollectionRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
@@ -1500,6 +1610,8 @@ interface ListDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
@@ -1582,6 +1694,8 @@ interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /** If set allowed for caller data permissions would be included in the response */
+    includeAllowedDataPermissions?: boolean;
     /**
      * Top-level collection properties to return, using camelCase names, such as `displayName`.
      * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.