@wix/multilingual 1.0.51 → 1.0.52

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

@@ -1312,10 +1312,9 @@ type MaybeContext$4<T extends Descriptors$4> = globalThis.ContextualClient exten
     host: Host$4;
 } ? BuildDescriptors$4<T, globalThis.ContextualClient['host']> : T;
 
-/** Represents a content of an entity with its published translations */
 interface PublishedContent {
     /**
-     * Pubished content ID.
+     * Published content ID.
      * @readonly
      */
     _id?: string | null;
@@ -1333,14 +1332,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$1 {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     appId?: string;
@@ -6903,20 +6902,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;
@@ -6943,18 +6942,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;
     /**
@@ -8265,7 +8268,7 @@ interface UpdateContentResponse {
     content?: Content;
 }
 interface UpdateContentByKeyRequest {
-    /** Content to be updated, may be partial. */
+    /** Content to update. */
     content: Content;
 }
 interface UpdateContentByKeyResponse {
@@ -8415,7 +8418,7 @@ interface PagingMetadataV2 {
     cursors?: Cursors$1;
 }
 interface SearchContentsRequest {
-    /** WQL expression, Aggregation and Search */
+    /** Search query and aggregation information. */
     search?: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -8873,7 +8876,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 {
@@ -8885,7 +8888,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;
@@ -8903,29 +8906,29 @@ 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 PermissiveBulkUpdateContentRequest {
@@ -8945,13 +8948,13 @@ interface PermissiveBulkUpdateContentResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface PermissiveBulkUpdateContentResponseBulkContentResult {
-    /** 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 {
@@ -9564,20 +9567,20 @@ interface UpdateContent {
     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;
@@ -9652,7 +9655,7 @@ interface ContentsQueryBuilder {
     find: () => Promise<ContentsQueryResult>;
 }
 interface SearchContentsOptions {
-    /** WQL expression, Aggregation and Search */
+    /** Search query and aggregation information. */
     search?: CursorSearch;
 }
 interface BulkCreateContentOptions {
@@ -9664,7 +9667,7 @@ interface BulkUpdateContentOptions {
     returnEntity?: boolean;
 }
 interface BulkUpdateContentByKeyOptions {
-    /** 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;
 }
 
@@ -9691,7 +9694,7 @@ interface GetContentSignature {
 declare function updateContent$1(httpClient: HttpClient$1): UpdateContentSignature;
 interface UpdateContentSignature {
     /**
-     * Updates a translation content item.
+     * Updates a translation content item by ID.
      *
      * To remove a field, pass the field key with an empty object as the value. For example:
      *
@@ -9708,7 +9711,7 @@ interface UpdateContentSignature {
 declare function updateContentByKey$1(httpClient: HttpClient$1): UpdateContentByKeySignature;
 interface UpdateContentByKeySignature {
     /**
-     * Updates a translation content item by key.
+     * Updates a translation content item using a unique key, which is a combination of `content.schemaId`, `content.entityId`, and `content.locale`.
      *
      * To remove a field, pass the field key with an empty object as the value. For example:
      *
@@ -9717,7 +9720,7 @@ interface UpdateContentByKeySignature {
      * "title": {}
      * }
      * ```
-     * @param - Content to be updated, may be partial.
+     * @param - Content to update.
      */
     (content: Content): Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
 }
@@ -9732,7 +9735,7 @@ interface DeleteContentSignature {
 declare function queryContents$1(httpClient: HttpClient$1): QueryContentsSignature;
 interface QueryContentsSignature {
     /**
-     * Retrieves a list of translation content given the provided paging, filtering, and sorting. Up to 100 translation content items can be returned per request.
+     * Retrieves a list of translation content items given the provided paging, filtering, and sorting. Up to 100 translation content items can be returned per request.
      *
      * The default `sort` is `id` in `ASC`.
      *
@@ -9747,7 +9750,7 @@ interface SearchContentsSignature {
     /**
      * Retrieves a list of all translation content associated with a site that matches the search query, with optional data aggregation.
      *
-     * Note that this method retrieves translation content created by you or others.
+     * Note that this method allows you to retrieve all translation content for a site, regardless of which app created it.
      *
      * Use this method to search translation content fields on a site for a given expression, and/or to perform data aggregations on a site's translation content fields.
      *
@@ -9770,16 +9773,32 @@ interface BulkCreateContentSignature {
 declare function bulkUpdateContent$1(httpClient: HttpClient$1): BulkUpdateContentSignature;
 interface BulkUpdateContentSignature {
     /**
-     * Updates multiple translation content items.
-     * @param - Contents to be updated. TODO: think again if we want to increase maxSize
+     * Updates multiple translation content items by ID.
+     *
+     * To remove a field, pass the field key with an empty object as the value. For example:
+     *
+     * ```json
+     * "fields": {
+     * "title": {}
+     * }
+     * ```
+     * @param - Translation content items to update.
      */
     (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions | undefined): Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
 }
 declare function bulkUpdateContentByKey$1(httpClient: HttpClient$1): BulkUpdateContentByKeySignature;
 interface BulkUpdateContentByKeySignature {
     /**
-     * update multiple Contents in a single request. Works synchronously. Each content is identified by a unique key, a combination of (schemaId, entityId, locale)
-     * @param - Contents to be updated. TODO: think again if we want to increase maxSize
+     * Updates multiple translation content items using a unique key, which is a combination of `contents.content.schemaId`, `contents.content.entityId`, and `contents.content.locale`.
+     *
+     * To remove a field, pass the field key with an empty object as the value. For example:
+     *
+     * ```json
+     * "fields": {
+     * "title": {}
+     * }
+     * ```
+     * @param - Translation content items to update.
      */
     (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions | undefined): Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
 }
@@ -9787,7 +9806,7 @@ declare function bulkDeleteContent$1(httpClient: HttpClient$1): BulkDeleteConten
 interface BulkDeleteContentSignature {
     /**
      * Deletes multiple translation content items.
-     * @param - Content ids to be deleted. TODO: think again if we want to increase maxSize
+     * @param - IDs of the translation content items to delete.
      */
     (contentIds: string[]): Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
 }
@@ -9828,15 +9847,21 @@ declare const bulkUpdateContentByKey: MaybeContext$1<BuildRESTFunction$1<typeof
 declare const bulkDeleteContent: MaybeContext$1<BuildRESTFunction$1<typeof bulkDeleteContent$1> & typeof bulkDeleteContent$1>;
 
 type _publicOnContentCreatedType = typeof onContentCreated$1;
-/** */
+/**
+ * Triggered when translation content is created.
+ */
 declare const onContentCreated: ReturnType<typeof createEventModule$1<_publicOnContentCreatedType>>;
 
 type _publicOnContentUpdatedType = typeof onContentUpdated$1;
-/** */
+/**
+ * Triggered when translation content is updated.
+ */
 declare const onContentUpdated: ReturnType<typeof createEventModule$1<_publicOnContentUpdatedType>>;
 
 type _publicOnContentDeletedType = typeof onContentDeleted$1;
-/** */
+/**
+ * Triggered when translation content is deleted.
+ */
 declare const onContentDeleted: ReturnType<typeof createEventModule$1<_publicOnContentDeletedType>>;
 
 type index_d$1_Aggregation = Aggregation;
@@ -10555,13 +10580,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.
@@ -10573,12 +10605,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;
@@ -10601,24 +10637,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;
@@ -10626,11 +10662,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;
@@ -10658,9 +10694,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 CreateSchemaRequest {
@@ -11274,7 +11310,7 @@ interface GetSchemaByKey {
 }
 interface GetSchemaByKeyIdentifiers {
     /**
-     * ID of app that created the schema.
+     * ID of the app that created the schema.
      * @readonly
      */
     keyAppId?: string;
@@ -11366,7 +11402,7 @@ interface ListSiteSchemasOptions {
 declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
 interface GetSchemaSignature {
     /**
-     * Retrieves a translation schema.
+     * Retrieves a translation schema by ID.
      * @param - ID of the translation schema to retrieve.
      * @returns The requested translation schema.
      */
@@ -11386,7 +11422,7 @@ interface QuerySchemasSignature {
      *
      * > **Note:**
      * >
-     * > This method can retrieve all schemas with a `GLOBAL` scope and `SITE` scope schemas for the site you are authorized for in the current API request.
+     * > This method can retrieve all schemas with a `GLOBAL` scope and schemas with a `SITE` scope for the site the API request is authorized to access.
      *
      * The default `sort` is `id` in `ASC`.
      *
@@ -11398,7 +11434,7 @@ interface QuerySchemasSignature {
 declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
 interface ListSiteSchemasSignature {
     /**
-     * Retrieves a list of all translation schemas associated with a site, including those created by you or other developers.
+     * Retrieves a list of all translation schemas associated with a site, regardless of which app created them.
      */
     (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
 }