@wix/multilingual 1.0.38 → 1.0.40

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

@@ -7802,22 +7802,27 @@ declare namespace meta$2 {
 
 interface Content$1 {
     /**
-     * Content ID.
+     * Translation content ID.
      * @readonly
      */
     id?: string | null;
-    /** Schema unique identifier */
+    /** Translation schema ID. */
     schemaId?: string;
-    /** Unique identifier that represents a specific entity in the app */
+    /** A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`. */
     entityId?: string;
-    /** Indicates the locale of this content */
+    /** Translation content locale. */
     locale?: string;
-    /** List of fields localized in the given language */
+    /** 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>;
-    /** Optional field that will group in the UI contents with the same group name */
+    /** 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. */
     parentEntityId?: string | null;
     /**
-     * The aggregated published status across all content fields
+     * 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.
      * @readonly
      */
     publishStatus?: PublishStatus$1;
@@ -7826,53 +7831,65 @@ interface Content$1 {
      * @readonly
      */
     previewField?: string | null;
-    /** @readonly */
+    /**
+     * Date and time the translation content was created.
+     * @readonly
+     */
     createdDate?: Date;
-    /** @readonly */
+    /**
+     * Date and time the translation content was updated.
+     * @readonly
+     */
     updatedDate?: Date;
 }
 interface ContentField$1 extends ContentFieldValueOneOf$1 {
-    /** Field actual localized content as simple text type */
+    /** Translated plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
     textValue?: string;
-    /** Use this field to send rich content. */
+    /** Translated rich content. */
     richContent?: RichContent$1;
-    /** Image media item */
+    /** Wix Media Manager image. */
     image?: Image$1;
-    /** Video media item */
+    /** Wix Media Manager video. */
     video?: VideoV2;
-    /** Document media item */
+    /** Wix Media Manager document. */
     document?: Document;
     /**
-     * Field unique identifier.
+     * 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 `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     id?: string;
-    /** Is content published to live site or not */
+    /** Whether to publish the translation content to the live site, making it visible to site visitors. */
     published?: boolean;
-    /** Describes the updater identity (site owner / app / auto translator) */
+    /**
+     * 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.
+     */
     updatedBy?: UpdaterIdentity$1;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis), must have a matching schema field key.
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
     /**
-     * Index is populated according to index of schema field (if exists), and grouping repeated fields.
+     * Field index. Used for cases where the order of the fields are relevant.
      * @readonly
      */
     index?: number;
 }
 /** @oneof */
 interface ContentFieldValueOneOf$1 {
-    /** Field actual localized content as simple text type */
+    /** Translated plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
     textValue?: string;
-    /** Use this field to send rich content. */
+    /** Translated rich content. */
     richContent?: RichContent$1;
-    /** Image media item */
+    /** Wix Media Manager image. */
     image?: Image$1;
-    /** Video media item */
+    /** Wix Media Manager video. */
     video?: VideoV2;
-    /** Document media item */
+    /** Wix Media Manager document. */
     document?: Document;
 }
 interface RichContent$1 {
@@ -9159,27 +9176,27 @@ declare enum PublishStatus$1 {
     PUBLISHED = "PUBLISHED"
 }
 interface CreateContentRequest$1 {
-    /** Content to be created. */
+    /** Translation content to create. */
     content: Content$1;
 }
 interface CreateContentResponse$1 {
-    /** The created Content. */
+    /** Newly created translation content. */
     content?: Content$1;
 }
 interface GetContentRequest$1 {
-    /** ID of the Content to retrieve. */
+    /** ID of the translation content to retrieve. */
     contentId: string;
 }
 interface GetContentResponse$1 {
-    /** The requested Content. */
+    /** The requested translation content. */
     content?: Content$1;
 }
 interface UpdateContentRequest$1 {
-    /** Content to be updated, may be partial. */
+    /** Translation content to update. */
     content: Content$1;
 }
 interface UpdateContentResponse$1 {
-    /** Updated Content. */
+    /** Updated translation content. */
     content?: Content$1;
 }
 interface UpdateContentByKeyRequest$1 {
@@ -9191,13 +9208,13 @@ interface UpdateContentByKeyResponse$1 {
     content?: Content$1;
 }
 interface DeleteContentRequest$1 {
-    /** Id of the Content to delete. */
+    /** ID of the translation content to delete. */
     contentId: string;
 }
 interface DeleteContentResponse$1 {
 }
 interface QueryContentsRequest$1 {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery$3;
 }
 interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
@@ -9251,9 +9268,9 @@ interface CursorPaging$3 {
     cursor?: string | null;
 }
 interface QueryContentsResponse$1 {
-    /** List of Contents. */
+    /** List of translation content. */
     contents?: Content$1[];
-    /** Paging metadata */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$3;
 }
 interface CursorPagingMetadata$3 {
@@ -9533,11 +9550,11 @@ declare enum Mode$1 {
     AND = "AND"
 }
 interface SearchContentsResponse$1 {
-    /** List of Contents. */
+    /** List of translation content. */
     contents?: Content$1[];
-    /** Paging metadata */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$3;
-    /** Aggregation data */
+    /** Aggregation data. */
     aggregationData?: AggregationData$1;
 }
 interface AggregationData$1 {
@@ -9702,15 +9719,15 @@ interface AggregationResultsResultOneOf$1 {
     nested?: NestedResults$1;
 }
 interface BulkCreateContentRequest$1 {
-    /** List of Contents to be created TODO: think again if we want to increase maxSize */
+    /** List of translation content. */
     contents: Content$1[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
     returnEntity?: boolean;
 }
 interface BulkCreateContentResponse$1 {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkContentResult$1[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface ItemMetadata$1 {
@@ -9732,9 +9749,9 @@ interface ApplicationError$1 {
     data?: Record<string, any> | null;
 }
 interface BulkContentResult$1 {
-    /** Defined in wix.commons */
+    /** 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 BulkActionMetadata$1 {
@@ -9748,23 +9765,23 @@ interface BulkActionMetadata$1 {
 interface BulkUpdateContentRequest$1 {
     /** Contents to be updated. TODO: think again if we want to increase maxSize */
     contents: BulkUpdateContentRequestMaskedContent$1[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
     returnEntity?: boolean;
 }
 interface BulkUpdateContentRequestMaskedContent$1 {
-    /** Content to be updated, may be partial */
+    /** Translation content to update. */
     content?: Content$1;
 }
 interface BulkUpdateContentResponse$1 {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkUpdateContentResponseBulkContentResult$1[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkUpdateContentResponseBulkContentResult$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 BulkUpdateContentByKeyRequest$1 {
@@ -9794,13 +9811,13 @@ interface BulkDeleteContentRequest$1 {
     contentIds: string[];
 }
 interface BulkDeleteContentResponse$1 {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkDeleteContentResponseBulkContentResult$1[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata$1;
 }
 interface BulkDeleteContentResponseBulkContentResult$1 {
-    /** metadata */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata$1;
 }
 interface ContentNonNullableFields$1 {
@@ -9928,22 +9945,27 @@ interface BulkDeleteContentResponseNonNullableFields$1 {
 
 interface Content {
     /**
-     * Content ID.
+     * Translation content ID.
      * @readonly
      */
     _id?: string | null;
-    /** Schema unique identifier */
+    /** Translation schema ID. */
     schemaId?: string;
-    /** Unique identifier that represents a specific entity in the app */
+    /** A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`. */
     entityId?: string;
-    /** Indicates the locale of this content */
+    /** Translation content locale. */
     locale?: string;
-    /** List of fields localized in the given language */
+    /** 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>;
-    /** Optional field that will group in the UI contents with the same group name */
+    /** 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. */
     parentEntityId?: string | null;
     /**
-     * The aggregated published status across all content fields
+     * 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.
      * @readonly
      */
     publishStatus?: PublishStatus;
@@ -9952,53 +9974,65 @@ interface Content {
      * @readonly
      */
     previewField?: string | null;
-    /** @readonly */
+    /**
+     * Date and time the translation content was created.
+     * @readonly
+     */
     _createdDate?: Date;
-    /** @readonly */
+    /**
+     * Date and time the translation content was updated.
+     * @readonly
+     */
     _updatedDate?: Date;
 }
 interface ContentField extends ContentFieldValueOneOf {
-    /** Field actual localized content as simple text type */
+    /** Translated plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
     textValue?: string;
-    /** Use this field to send rich content. */
+    /** Translated rich content. */
     richContent?: RichContent;
-    /** Image media item */
+    /** Wix Media Manager image. */
     image?: string;
-    /** Video media item */
+    /** Wix Media Manager video. */
     video?: string;
-    /** Document media item */
+    /** Wix Media Manager document. */
     document?: string;
     /**
-     * Field unique identifier.
+     * 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 `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     _id?: string;
-    /** Is content published to live site or not */
+    /** Whether to publish the translation content to the live site, making it visible to site visitors. */
     published?: boolean;
-    /** Describes the updater identity (site owner / app / auto translator) */
+    /**
+     * 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.
+     */
     updatedBy?: UpdaterIdentity;
     /**
-     * The corresponding field key in the schema in a clean format (nothing between the parenthesis), must have a matching schema field key.
+     * Unique string identifier that links a specific content field to its corresponding field in the schema.
      * @readonly
      */
     schemaFieldKey?: string;
     /**
-     * Index is populated according to index of schema field (if exists), and grouping repeated fields.
+     * Field index. Used for cases where the order of the fields are relevant.
      * @readonly
      */
     index?: number;
 }
 /** @oneof */
 interface ContentFieldValueOneOf {
-    /** Field actual localized content as simple text type */
+    /** Translated plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
     textValue?: string;
-    /** Use this field to send rich content. */
+    /** Translated rich content. */
     richContent?: RichContent;
-    /** Image media item */
+    /** Wix Media Manager image. */
     image?: string;
-    /** Video media item */
+    /** Wix Media Manager video. */
     video?: string;
-    /** Document media item */
+    /** Wix Media Manager document. */
     document?: string;
 }
 interface RichContent {
@@ -11230,27 +11264,27 @@ declare enum PublishStatus {
     PUBLISHED = "PUBLISHED"
 }
 interface CreateContentRequest {
-    /** Content to be created. */
+    /** Translation content to create. */
     content: Content;
 }
 interface CreateContentResponse {
-    /** The created Content. */
+    /** Newly created translation content. */
     content?: Content;
 }
 interface GetContentRequest {
-    /** ID of the Content to retrieve. */
+    /** ID of the translation content to retrieve. */
     contentId: string;
 }
 interface GetContentResponse {
-    /** The requested Content. */
+    /** The requested translation content. */
     content?: Content;
 }
 interface UpdateContentRequest {
-    /** Content to be updated, may be partial. */
+    /** Translation content to update. */
     content: Content;
 }
 interface UpdateContentResponse {
-    /** Updated Content. */
+    /** Updated translation content. */
     content?: Content;
 }
 interface UpdateContentByKeyRequest {
@@ -11262,13 +11296,13 @@ interface UpdateContentByKeyResponse {
     content?: Content;
 }
 interface DeleteContentRequest {
-    /** Id of the Content to delete. */
+    /** ID of the translation content to delete. */
     contentId: string;
 }
 interface DeleteContentResponse {
 }
 interface QueryContentsRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery$2;
 }
 interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
@@ -11322,9 +11356,9 @@ interface CursorPaging$2 {
     cursor?: string | null;
 }
 interface QueryContentsResponse {
-    /** List of Contents. */
+    /** List of translation content. */
     contents?: Content[];
-    /** Paging metadata */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {
@@ -11604,11 +11638,11 @@ declare enum Mode {
     AND = "AND"
 }
 interface SearchContentsResponse {
-    /** List of Contents. */
+    /** List of translation content. */
     contents?: Content[];
-    /** Paging metadata */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata$2;
-    /** Aggregation data */
+    /** Aggregation data. */
     aggregationData?: AggregationData;
 }
 interface AggregationData {
@@ -11773,15 +11807,15 @@ interface AggregationResultsResultOneOf {
     nested?: NestedResults;
 }
 interface BulkCreateContentRequest {
-    /** List of Contents to be created TODO: think again if we want to increase maxSize */
+    /** List of translation content. */
     contents: Content[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
     returnEntity?: boolean;
 }
 interface BulkCreateContentResponse {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkContentResult[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface ItemMetadata {
@@ -11803,9 +11837,9 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkContentResult {
-    /** Defined in wix.commons */
+    /** 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 BulkActionMetadata {
@@ -11819,23 +11853,23 @@ interface BulkActionMetadata {
 interface BulkUpdateContentRequest {
     /** Contents to be updated. TODO: think again if we want to increase maxSize */
     contents: BulkUpdateContentRequestMaskedContent[];
-    /** set to `true` if you wish to receive back the created contents in the response */
+    /** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
     returnEntity?: boolean;
 }
 interface BulkUpdateContentRequestMaskedContent {
-    /** Content to be updated, may be partial */
+    /** Translation content to update. */
     content?: Content;
 }
 interface BulkUpdateContentResponse {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkUpdateContentResponseBulkContentResult[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateContentResponseBulkContentResult {
-    /** 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 BulkUpdateContentByKeyRequest {
@@ -11865,13 +11899,13 @@ interface BulkDeleteContentRequest {
     contentIds: string[];
 }
 interface BulkDeleteContentResponse {
-    /** List of results */
+    /** Items created by bulk action. */
     results?: BulkDeleteContentResponseBulkContentResult[];
-    /** metadata */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteContentResponseBulkContentResult {
-    /** metadata */
+    /** Item metadata. */
     itemMetadata?: ItemMetadata;
 }
 interface ContentNonNullableFields {
@@ -12042,29 +12076,35 @@ declare namespace meta$1 {
 
 interface Schema$1 {
     /**
-     * Schema ID.
+     * Translation schema ID.
      * @readonly
      */
     id?: string | null;
-    /** (compound key) Schema key. */
+    /** Translation schema unique key identifier. */
     key?: SchemaKey$1;
-    /** A list of unique fields on the entity in the specific language */
+    /** List of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map<string, SchemaField>`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content. */
     fields?: Record<string, SchemaField$1>;
-    /** Fields that will be displayed in content previews (e.g., product name for products). */
+    /** Fields displayed in content previews. For example, a product name for a product translation schema. */
     previewFields?: PreviewFields$1;
-    /** Whether the schema is hidden from the site. */
+    /** Whether the translation schema is hidden from the site. */
     hidden?: boolean | null;
-    /** The name of the schema */
+    /** Translation schema name. */
     displayName?: string | null;
-    /** Higher level schema, group_by_name will point to an entity of this schema. */
+    /** 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. */
     parentId?: string | null;
     /** @readonly */
     revision?: string | null;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was created.
+     * @readonly
+     */
     createdDate?: Date;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was updated.
+     * @readonly
+     */
     updatedDate?: Date;
-    /** indicate if the content should be duplicated when the site is cloned */
+    /** Whether to duplicate the translated content in the schema when a site containing the translation schema and content is duplicated. */
     duplicateContent?: boolean | null;
 }
 interface SchemaKey$1 {
@@ -12073,9 +12113,14 @@ interface SchemaKey$1 {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope$1;
 }
 declare enum SchemaScope$1 {
@@ -12087,27 +12132,38 @@ declare enum SchemaScope$1 {
 }
 interface SchemaField$1 {
     /**
-     * Field ID.
+     * 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 `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     id?: string;
-    /** Field type. */
+    /**
+     * Field type.
+     * Supported values:
+     * + `SHORT_TEXT`: Short plain text.
+     * + `LONG_TEXT`: Long plain text.
+     * + `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.
+     * + `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 descriptive name. */
+    /** Field name. */
     displayName?: string | null;
-    /** Field semantic grouping */
+    /** Field group name. */
     groupName?: string | null;
-    /** Field minimum length (in case of text field) */
+    /** Field minimum text length. */
     minLength?: number | null;
-    /** Field maximum length (in case text field) */
+    /** Field maximum text length. */
     maxLength?: number | null;
-    /** Field format. If set - must be one of the values of wix.api.format as string (case insensitive) */
+    /** 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. */
     format?: string | null;
-    /** Whether the field is hidden from the site. Hidden field constraints (type, min/max length) are still active! */
+    /** Whether the field is hidden from the site. Hidden fields are still validated. */
     hidden?: boolean;
-    /** Whether the field is for display only and should not allowed to be translated */
+    /** 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. */
     displayOnly?: boolean;
-    /** In cases where the order of the fields holds meaning, use this index */
+    /** Field index. Use for cases where the order of the fields are relevant. */
     index?: number | null;
 }
 declare enum FieldType$1 {
@@ -12139,46 +12195,52 @@ interface PreviewFields$1 {
     imageFieldId?: string | null;
 }
 interface GetSchemaRequest$1 {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     schemaId: string;
 }
 interface GetSchemaResponse$1 {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema$1;
 }
 interface GetSchemaByKeyRequest$1 {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     key: SchemaKey$1;
 }
 interface GetSchemaByKeyResponse$1 {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema$1;
 }
 interface QuerySchemasRequest$1 {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery$1;
 }
 interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$1;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$1[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$1 {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$1;
 }
 interface Sorting$1 {
@@ -12203,13 +12265,13 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QuerySchemasResponse$1 {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema$1[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$1;
@@ -12232,9 +12294,9 @@ interface ListSiteSchemasRequest$1 {
     paging?: CursorPaging$1;
 }
 interface ListSiteSchemasResponse$1 {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema$1[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata$1;
 }
 interface SchemaKeyNonNullableFields$1 {
@@ -12260,29 +12322,35 @@ interface ListSiteSchemasResponseNonNullableFields$1 {
 
 interface Schema {
     /**
-     * Schema ID.
+     * Translation schema ID.
      * @readonly
      */
     _id?: string | null;
-    /** (compound key) Schema key. */
+    /** Translation schema unique key identifier. */
     key?: SchemaKey;
-    /** A list of unique fields on the entity in the specific language */
+    /** List of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map<string, SchemaField>`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content. */
     fields?: Record<string, SchemaField>;
-    /** Fields that will be displayed in content previews (e.g., product name for products). */
+    /** Fields displayed in content previews. For example, a product name for a product translation schema. */
     previewFields?: PreviewFields;
-    /** Whether the schema is hidden from the site. */
+    /** Whether the translation schema is hidden from the site. */
     hidden?: boolean | null;
-    /** The name of the schema */
+    /** Translation schema name. */
     displayName?: string | null;
-    /** Higher level schema, group_by_name will point to an entity of this schema. */
+    /** 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. */
     parentId?: string | null;
     /** @readonly */
     revision?: string | null;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was created.
+     * @readonly
+     */
     _createdDate?: Date;
-    /** @readonly */
+    /**
+     * Date and time the translation schema was updated.
+     * @readonly
+     */
     _updatedDate?: Date;
-    /** indicate if the content should be duplicated when the site is cloned */
+    /** Whether to duplicate the translated content in the schema when a site containing the translation schema and content is duplicated. */
     duplicateContent?: boolean | null;
 }
 interface SchemaKey {
@@ -12291,9 +12359,14 @@ interface SchemaKey {
      * @readonly
      */
     appId?: string;
-    /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
+    /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
     entityType?: string;
-    /** Scope schema is defined in (Global/Site) */
+    /**
+     * Scope of the translation schema.
+     * Supported values:
+     * + `GLOBAL`: A global schema for all sites.
+     * + `SITE`: A custom schema for a specific site.
+     */
     scope?: SchemaScope;
 }
 declare enum SchemaScope {
@@ -12305,27 +12378,38 @@ declare enum SchemaScope {
 }
 interface SchemaField {
     /**
-     * Field ID.
+     * 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 `^[^)(\\]\\[\\.]+$`.
      * @readonly
      */
     _id?: string;
-    /** Field type. */
+    /**
+     * Field type.
+     * Supported values:
+     * + `SHORT_TEXT`: Short plain text.
+     * + `LONG_TEXT`: Long plain text.
+     * + `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.
+     * + `IMAGE`: Wix Media Manager image.
+     * + `IMAGE_LINK`: Image URL without metadata.
+     * + `VIDEO`: Wix Media Manager video.
+     * + `DOCUMENT`: Wix Media Manager document.
+     */
     type?: FieldType;
-    /** Field descriptive name. */
+    /** Field name. */
     displayName?: string | null;
-    /** Field semantic grouping */
+    /** Field group name. */
     groupName?: string | null;
-    /** Field minimum length (in case of text field) */
+    /** Field minimum text length. */
     minLength?: number | null;
-    /** Field maximum length (in case text field) */
+    /** Field maximum text length. */
     maxLength?: number | null;
-    /** Field format. If set - must be one of the values of wix.api.format as string (case insensitive) */
+    /** 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. */
     format?: string | null;
-    /** Whether the field is hidden from the site. Hidden field constraints (type, min/max length) are still active! */
+    /** Whether the field is hidden from the site. Hidden fields are still validated. */
     hidden?: boolean;
-    /** Whether the field is for display only and should not allowed to be translated */
+    /** 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. */
     displayOnly?: boolean;
-    /** In cases where the order of the fields holds meaning, use this index */
+    /** Field index. Use for cases where the order of the fields are relevant. */
     index?: number | null;
 }
 declare enum FieldType {
@@ -12357,46 +12441,52 @@ interface PreviewFields {
     imageFieldId?: string | null;
 }
 interface GetSchemaRequest {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     schemaId: string;
 }
 interface GetSchemaResponse {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema;
 }
 interface GetSchemaByKeyRequest {
-    /** ID of the Schema to retrieve. */
+    /** ID of the translation schema to retrieve. */
     key: SchemaKey;
 }
 interface GetSchemaByKeyResponse {
-    /** The requested Schema. */
+    /** The requested translation schema. */
     schema?: Schema;
 }
 interface QuerySchemasRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
 }
 interface Sorting {
@@ -12421,13 +12511,13 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QuerySchemasResponse {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors;
@@ -12450,9 +12540,9 @@ interface ListSiteSchemasRequest {
     paging?: CursorPaging;
 }
 interface ListSiteSchemasResponse {
-    /** List of Schemas. */
+    /** List of translation schemas. */
     schemas?: Schema[];
-    /** Paging metadata */
+    /** Paging metadata for the next page of results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface SchemaKeyNonNullableFields {