@wix/multilingual 1.0.51 → 1.0.52

package/type-bundles/meta.bundle.d.ts

@@ -37,10 +37,9 @@ declare namespace meta$5 {
   export { type __PublicMethodMetaInfo$5 as __PublicMethodMetaInfo, meta$5_syncEditorData as syncEditorData };
 }
 
-/** Represents a content of an entity with its published translations */
 interface PublishedContent$1 {
     /**
-     * Pubished content ID.
+     * Published content ID.
      * @readonly
      */
     id?: string | null;
@@ -58,14 +57,14 @@ interface PublishedContent$1 {
     locale?: string;
     /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField$1[];
-    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
+    /** A reference to the parent content. For example, if the content is a menu item, this property would contain the `entityId` of the menu it belongs to. */
     parentEntityId?: string | null;
     /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields$1;
 }
 interface SchemaKey$3 {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     appId?: string;
@@ -1765,10 +1764,9 @@ interface QueryPublishedContentResponseNonNullableFields$1 {
     publishedContent: PublishedContentNonNullableFields$1[];
 }
 
-/** Represents a content of an entity with its published translations */
 interface PublishedContent {
     /**
-     * Pubished content ID.
+     * Published content ID.
      * @readonly
      */
     _id?: string | null;
@@ -1786,14 +1784,14 @@ interface PublishedContent {
     locale?: string;
     /** List of fields that have been translated and published for the given locale. */
     fields?: PublishedContentField[];
-    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
+    /** A reference to the parent content. For example, if the content is a menu item, this property would contain the `entityId` of the menu it belongs to. */
     parentEntityId?: string | null;
     /** Custom field data for the published content object. */
     extendedFields?: ExtendedFields;
 }
 interface SchemaKey$2 {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     appId?: string;
@@ -7822,20 +7820,20 @@ interface Content$1 {
     locale?: string;
     /** List of fields for the translation content. This property uses a string to map to a `ContentField` (`Map<string, ContentField>`). The string serves as a key, which you'll need to access each field in the content and when referencing a translation schema. */
     fields?: Record<string, ContentField$1>;
-    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content with the `entityId` of the menu it belongs to. */
+    /** A reference to the parent content. For example, if the content is a menu item, this property would contain the `entityId` of the menu it belongs to. */
     parentEntityId?: string | null;
     /**
      * The aggregated published status across all content fields.
      *
      * Supported values:
-     * + `UNPUBLISHED`: None of the fields have been published to the live site.
-     * + `PUBLISHED`: All of the fields have been published to the live site and are visible to site visitors.
-     * + `PARTIALLY_PUBLISHED`: Some of the fields have been published to the live site and are visible to site visitors.
+     * + `UNPUBLISHED`: None of the fields have been sent for publication.
+     * + `PUBLISHED`: All of the fields have been sent for publication.
+     * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
      * @readonly
      */
     publishStatus?: PublishStatus$1;
     /**
-     * Contains the value of the preview field according to the schema if exists.
+     * Contains the value of the preview field if the schema defines one.
      * @readonly
      */
     previewField?: string | null;
@@ -7862,18 +7860,22 @@ interface ContentField$1 extends ContentFieldValueOneOf$1 {
     /** Wix Media Manager document. */
     document?: Document;
     /**
-     * Field unique identifier. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parenthesis to reference repeated items, such as images. These parenthesis can't be nested and each open one must have a closed one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
+     * Field unique identifier. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     id?: string;
-    /** Whether to publish the translation content to the live site, making it visible to site visitors. */
+    /**
+     * Whether to publish the translation content to the live site, making it visible to site visitors.
+     *
+     * Default: `false`
+     */
     published?: boolean;
     /**
-     * The source that updated the translation content.
+     * *Required.** The source that updated the translation content.
      * Supported values:
-     * + `USER`: The site owner.
-     * + `EXTERNAL_APP`: An external translation app. For example, Smartling.
-     * + `Machine`: Auto translaton service. For example, Google Translate.
+     * + `USER`: The Wix user.
+     * + `EXTERNAL_APP`: An external translation app.
+     * + `MACHINE`: Machine translaton service.
      */
     updatedBy?: UpdaterIdentity$1;
     /**
@@ -9210,7 +9212,7 @@ interface UpdateContentResponse$1 {
     content?: Content$1;
 }
 interface UpdateContentByKeyRequest$1 {
-    /** Content to be updated, may be partial. */
+    /** Content to update. */
     content: Content$1;
 }
 interface UpdateContentByKeyResponse$1 {
@@ -9303,7 +9305,7 @@ interface Cursors$3 {
     prev?: string | null;
 }
 interface SearchContentsRequest$1 {
-    /** WQL expression, Aggregation and Search */
+    /** Search query and aggregation information. */
     search?: CursorSearch$1;
 }
 interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
@@ -9761,7 +9763,7 @@ interface ApplicationError$1 {
 interface BulkContentResult$1 {
     /** Item metadata. */
     itemMetadata?: ItemMetadata$1;
-    /** Translation Content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content$1;
 }
 interface BulkActionMetadata$1 {
@@ -9773,7 +9775,7 @@ interface BulkActionMetadata$1 {
     undetailedFailures?: number;
 }
 interface BulkUpdateContentRequest$1 {
-    /** Contents to be updated. TODO: think again if we want to increase maxSize */
+    /** Translation content items to update. */
     contents: BulkUpdateContentRequestMaskedContent$1[];
     /** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
     returnEntity?: boolean;
@@ -9791,33 +9793,33 @@ interface BulkUpdateContentResponse$1 {
 interface BulkUpdateContentResponseBulkContentResult$1 {
     /** Item metadata. */
     itemMetadata?: ItemMetadata$1;
-    /** Translation Content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content$1;
 }
 interface BulkUpdateContentByKeyRequest$1 {
-    /** Contents to be updated. TODO: think again if we want to increase maxSize */
+    /** Translation content items to update. */
     contents: MaskedContent$1[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
     returnEntity?: boolean;
 }
 interface MaskedContent$1 {
-    /** Content to be updated, may be partial */
+    /** Translation content to update. */
     content?: Content$1;
 }
 interface BulkUpdateContentByKeyResponse$1 {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkUpdateContentByKeyResponseBulkContentResult$1[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkUpdateContentByKeyResponseBulkContentResult$1 {
-    /** metadata */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata$1;
-    /** Only exists if `returnEntity` was set to true in the request */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content$1;
 }
 interface BulkDeleteContentRequest$1 {
-    /** Content ids to be deleted. TODO: think again if we want to increase maxSize */
+    /** IDs of the translation content items to delete. */
     contentIds: string[];
 }
 interface BulkDeleteContentResponse$1 {
@@ -9967,20 +9969,20 @@ interface Content {
     locale?: string;
     /** List of fields for the translation content. This property uses a string to map to a `ContentField` (`Map<string, ContentField>`). The string serves as a key, which you'll need to access each field in the content and when referencing a translation schema. */
     fields?: Record<string, ContentField>;
-    /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content with the `entityId` of the menu it belongs to. */
+    /** A reference to the parent content. For example, if the content is a menu item, this property would contain the `entityId` of the menu it belongs to. */
     parentEntityId?: string | null;
     /**
      * The aggregated published status across all content fields.
      *
      * Supported values:
-     * + `UNPUBLISHED`: None of the fields have been published to the live site.
-     * + `PUBLISHED`: All of the fields have been published to the live site and are visible to site visitors.
-     * + `PARTIALLY_PUBLISHED`: Some of the fields have been published to the live site and are visible to site visitors.
+     * + `UNPUBLISHED`: None of the fields have been sent for publication.
+     * + `PUBLISHED`: All of the fields have been sent for publication.
+     * + `PARTIALLY_PUBLISHED`: Some of the fields have been sent for publication.
      * @readonly
      */
     publishStatus?: PublishStatus;
     /**
-     * Contains the value of the preview field according to the schema if exists.
+     * Contains the value of the preview field if the schema defines one.
      * @readonly
      */
     previewField?: string | null;
@@ -10007,18 +10009,22 @@ interface ContentField extends ContentFieldValueOneOf {
     /** Wix Media Manager document. */
     document?: string;
     /**
-     * Field unique identifier. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parenthesis to reference repeated items, such as images. These parenthesis can't be nested and each open one must have a closed one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
+     * Field unique identifier. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     _id?: string;
-    /** Whether to publish the translation content to the live site, making it visible to site visitors. */
+    /**
+     * Whether to publish the translation content to the live site, making it visible to site visitors.
+     *
+     * Default: `false`
+     */
     published?: boolean;
     /**
-     * The source that updated the translation content.
+     * *Required.** The source that updated the translation content.
      * Supported values:
-     * + `USER`: The site owner.
-     * + `EXTERNAL_APP`: An external translation app. For example, Smartling.
-     * + `Machine`: Auto translaton service. For example, Google Translate.
+     * + `USER`: The Wix user.
+     * + `EXTERNAL_APP`: An external translation app.
+     * + `MACHINE`: Machine translaton service.
      */
     updatedBy?: UpdaterIdentity;
     /**
@@ -11300,7 +11306,7 @@ interface UpdateContentResponse {
     content?: Content;
 }
 interface UpdateContentByKeyRequest {
-    /** Content to be updated, may be partial. */
+    /** Content to update. */
     content: Content;
 }
 interface UpdateContentByKeyResponse {
@@ -11393,7 +11399,7 @@ interface Cursors$2 {
     prev?: string | null;
 }
 interface SearchContentsRequest {
-    /** WQL expression, Aggregation and Search */
+    /** Search query and aggregation information. */
     search?: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -11851,7 +11857,7 @@ interface ApplicationError {
 interface BulkContentResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** Translation Content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content;
 }
 interface BulkActionMetadata {
@@ -11863,7 +11869,7 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface BulkUpdateContentRequest {
-    /** Contents to be updated. TODO: think again if we want to increase maxSize */
+    /** Translation content items to update. */
     contents: BulkUpdateContentRequestMaskedContent[];
     /** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
     returnEntity?: boolean;
@@ -11881,33 +11887,33 @@ interface BulkUpdateContentResponse {
 interface BulkUpdateContentResponseBulkContentResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** Translation Content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content;
 }
 interface BulkUpdateContentByKeyRequest {
-    /** Contents to be updated. TODO: think again if we want to increase maxSize */
+    /** Translation content items to update. */
     contents: MaskedContent[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
     returnEntity?: boolean;
 }
 interface MaskedContent {
-    /** Content to be updated, may be partial */
+    /** Translation content to update. */
     content?: Content;
 }
 interface BulkUpdateContentByKeyResponse {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkUpdateContentByKeyResponseBulkContentResult[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateContentByKeyResponseBulkContentResult {
-    /** metadata */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** Only exists if `returnEntity` was set to true in the request */
+    /** Translation content. This field is only returned if the operation was successful and `returnEntity` was set to true in the request. */
     item?: Content;
 }
 interface BulkDeleteContentRequest {
-    /** Content ids to be deleted. TODO: think again if we want to increase maxSize */
+    /** IDs of the translation content items to delete. */
     contentIds: string[];
 }
 interface BulkDeleteContentResponse {
@@ -12098,13 +12104,20 @@ interface Schema$1 {
     fields?: Record<string, SchemaField$1>;
     /** Fields displayed in content previews. For example, a product name for a product translation schema. */
     previewFields?: PreviewFields$1;
-    /** Whether the translation schema is hidden from the site. */
+    /**
+     * Whether the translation schema is hidden from the site.
+     *
+     * Default: `false`
+     */
     hidden?: boolean | null;
-    /** Translation schema name. */
+    /** Translation schema name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager. */
     displayName?: string | null;
-    /** A reference to the parent schema defined by the app developer. For example, if the schema is for a menu item, this property would link to the schema of the menu it belongs to. */
+    /** A reference to the parent schema. For example, if the schema is for a menu item, this property would contain the schema ID of the menu it belongs to. */
     parentId?: string | null;
-    /** @readonly */
+    /**
+     * Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing `revision` must be used when updating a schema.
+     * @readonly
+     */
     revision?: string | null;
     /**
      * Date and time the translation schema was created.
@@ -12116,12 +12129,16 @@ interface Schema$1 {
      * @readonly
      */
     updatedDate?: Date;
-    /** Whether to duplicate the translated content in the schema when a site containing the translation schema and content is duplicated. */
+    /**
+     * Whether to duplicate the translated content when a site containing the translation schema and content is duplicated.
+     *
+     * Default: `false`
+     */
     duplicateContent?: boolean | null;
 }
 interface SchemaKey$1 {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     appId?: string;
@@ -12144,24 +12161,24 @@ declare enum SchemaScope$1 {
 }
 interface SchemaField$1 {
     /**
-     * Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parenthesis to reference repeated items, such as images. These parenthesis can't be nested and each open one must have a closed one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
+     * Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     id?: string;
     /**
-     * Field type.
+     * *Required.** Field type.
      * Supported values:
-     * + `SHORT_TEXT`: Short plain text.
-     * + `LONG_TEXT`: Long plain text.
+     * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
+     * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
      * + `HTML`: Long text including styles, images, and links.
-     * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos.js](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
+     * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
      * + `IMAGE`: Wix Media Manager image.
      * + `IMAGE_LINK`: Image URL without metadata.
      * + `VIDEO`: Wix Media Manager video.
      * + `DOCUMENT`: Wix Media Manager document.
      */
     type?: FieldType$1;
-    /** Field name. */
+    /** Field name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager. */
     displayName?: string | null;
     /** Field group name. */
     groupName?: string | null;
@@ -12169,11 +12186,11 @@ interface SchemaField$1 {
     minLength?: number | null;
     /** Field maximum text length. */
     maxLength?: number | null;
-    /** Field format. The content will be validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address. */
+    /** Field format. Content is validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address. */
     format?: string | null;
     /** Whether the field is hidden from the site. Hidden fields are still validated. */
     hidden?: boolean;
-    /** Whether the field is read-only, and is not meant to be translated. For example, an image. Use this field as a way to provide more context for the field in the Multilingual Dashboard. */
+    /** Whether the field is read-only, and not intended to be translated. For example, an image. Use this field when you want an image to remain in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) for context, but without being translated. */
     displayOnly?: boolean;
     /** Field index. Use for cases where the order of the fields are relevant. */
     index?: number | null;
@@ -12201,9 +12218,9 @@ declare enum FieldType$1 {
     DOCUMENT = "DOCUMENT"
 }
 interface PreviewFields$1 {
-    /** ID of field representing the schema's title. */
+    /** ID of the field representing the schema's title. */
     titleFieldId?: string | null;
-    /** ID of field representing the schema's image. */
+    /** ID of the field representing the schema's image. */
     imageFieldId?: string | null;
 }
 interface GetSchemaRequest$1 {
@@ -12355,13 +12372,20 @@ interface Schema {
     fields?: Record<string, SchemaField>;
     /** Fields displayed in content previews. For example, a product name for a product translation schema. */
     previewFields?: PreviewFields;
-    /** Whether the translation schema is hidden from the site. */
+    /**
+     * Whether the translation schema is hidden from the site.
+     *
+     * Default: `false`
+     */
     hidden?: boolean | null;
-    /** Translation schema name. */
+    /** Translation schema name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager. */
     displayName?: string | null;
-    /** A reference to the parent schema defined by the app developer. For example, if the schema is for a menu item, this property would link to the schema of the menu it belongs to. */
+    /** A reference to the parent schema. For example, if the schema is for a menu item, this property would contain the schema ID of the menu it belongs to. */
     parentId?: string | null;
-    /** @readonly */
+    /**
+     * Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing `revision` must be used when updating a schema.
+     * @readonly
+     */
     revision?: string | null;
     /**
      * Date and time the translation schema was created.
@@ -12373,12 +12397,16 @@ interface Schema {
      * @readonly
      */
     _updatedDate?: Date;
-    /** Whether to duplicate the translated content in the schema when a site containing the translation schema and content is duplicated. */
+    /**
+     * Whether to duplicate the translated content when a site containing the translation schema and content is duplicated.
+     *
+     * Default: `false`
+     */
     duplicateContent?: boolean | null;
 }
 interface SchemaKey {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     appId?: string;
@@ -12401,24 +12429,24 @@ declare enum SchemaScope {
 }
 interface SchemaField {
     /**
-     * Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parenthesis to reference repeated items, such as images. These parenthesis can't be nested and each open one must have a closed one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
+     * Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     _id?: string;
     /**
-     * Field type.
+     * *Required.** Field type.
      * Supported values:
-     * + `SHORT_TEXT`: Short plain text.
-     * + `LONG_TEXT`: Long plain text.
+     * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
+     * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
      * + `HTML`: Long text including styles, images, and links.
-     * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos.js](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
+     * + `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.
      * + `IMAGE`: Wix Media Manager image.
      * + `IMAGE_LINK`: Image URL without metadata.
      * + `VIDEO`: Wix Media Manager video.
      * + `DOCUMENT`: Wix Media Manager document.
      */
     type?: FieldType;
-    /** Field name. */
+    /** Field name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager. */
     displayName?: string | null;
     /** Field group name. */
     groupName?: string | null;
@@ -12426,11 +12454,11 @@ interface SchemaField {
     minLength?: number | null;
     /** Field maximum text length. */
     maxLength?: number | null;
-    /** Field format. The content will be validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address. */
+    /** Field format. Content is validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address. */
     format?: string | null;
     /** Whether the field is hidden from the site. Hidden fields are still validated. */
     hidden?: boolean;
-    /** Whether the field is read-only, and is not meant to be translated. For example, an image. Use this field as a way to provide more context for the field in the Multilingual Dashboard. */
+    /** Whether the field is read-only, and not intended to be translated. For example, an image. Use this field when you want an image to remain in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) for context, but without being translated. */
     displayOnly?: boolean;
     /** Field index. Use for cases where the order of the fields are relevant. */
     index?: number | null;
@@ -12458,9 +12486,9 @@ declare enum FieldType {
     DOCUMENT = "DOCUMENT"
 }
 interface PreviewFields {
-    /** ID of field representing the schema's title. */
+    /** ID of the field representing the schema's title. */
     titleFieldId?: string | null;
-    /** ID of field representing the schema's image. */
+    /** ID of the field representing the schema's image. */
     imageFieldId?: string | null;
 }
 interface GetSchemaRequest {