@wix/multilingual 1.0.39 → 1.0.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/multilingual",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "@wix/multilingual_entity-mapper": "1.0.11",
     "@wix/multilingual_machine-translation": "1.0.26",
     "@wix/multilingual_site-translator": "1.0.12",
-    "@wix/multilingual_translation-contents": "1.0.15",
+    "@wix/multilingual_translation-contents": "1.0.16",
     "@wix/multilingual_translation-published-contents": "1.0.4",
     "@wix/multilingual_translation-schemas": "1.0.14"
   },
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "37a235f0ee89098d7ac7c94dccd0ba00860896c0b2cefd9c3c2aae0a"
+  "falconPackageHash": "c2ec495b3cb885bb418ba1203b021ab520e5bff219fcb41167eb7fd4"
 }

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

@@ -4831,22 +4831,27 @@ declare namespace context$2 {
 
 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;
@@ -4855,53 +4860,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 {
@@ -6162,27 +6179,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 {
@@ -6194,13 +6211,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$1;
 }
 interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
@@ -6254,9 +6271,9 @@ interface CursorPaging$1 {
     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$1;
 }
 interface CursorPagingMetadata$1 {
@@ -6318,9 +6335,9 @@ interface Paging {
     offset?: number | null;
 }
 interface QueryContentsLegacyResponse {
-    /** List of Contents. */
+    /** List of translation content. */
     contents?: Content[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: PagingMetadataV2;
 }
 interface PagingMetadataV2 {
@@ -6593,11 +6610,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$1;
-    /** Aggregation data */
+    /** Aggregation data. */
     aggregationData?: AggregationData;
 }
 interface AggregationData {
@@ -6762,15 +6779,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 {
@@ -6792,9 +6809,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 {
@@ -6808,23 +6825,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 {
@@ -6876,13 +6893,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 MetaSiteSpecialEvent$1 extends MetaSiteSpecialEventPayloadOneOf$1 {
@@ -7464,22 +7481,27 @@ interface ContentDeletedEnvelope {
 }
 interface UpdateContent {
     /**
-     * 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;
@@ -7488,9 +7510,15 @@ interface UpdateContent {
      * @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 QueryContentsOptions {
@@ -7557,11 +7585,11 @@ interface SearchContentsOptions {
     search?: CursorSearch;
 }
 interface BulkCreateContentOptions {
-    /** 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 BulkUpdateContentOptions {
-    /** 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 BulkUpdateContentByKeyOptions {
@@ -7572,36 +7600,52 @@ interface BulkUpdateContentByKeyOptions {
 declare function createContent$1(httpClient: HttpClient): CreateContentSignature;
 interface CreateContentSignature {
     /**
-     * Creates a Content.
+     * Creates a translation content item.
      *
-     * The request body must include schema-id, entity-id and locale.
-     * @param - Content to be created.
-     * @returns The created Content.
+     * The content is validated based on the constraints defined in the corresponding schema.
+     * @param - Translation content to create.
+     * @returns Newly created translation content.
      */
     (content: Content): Promise<Content & ContentNonNullableFields>;
 }
 declare function getContent$1(httpClient: HttpClient): GetContentSignature;
 interface GetContentSignature {
     /**
-     * Retrieves a Content.
-     * @param - ID of the Content to retrieve.
-     * @returns The requested Content.
+     * Retrieves a translation content item.
+     * @param - ID of the translation content to retrieve.
+     * @returns The requested translation content.
      */
     (contentId: string): Promise<Content & ContentNonNullableFields>;
 }
 declare function updateContent$1(httpClient: HttpClient): UpdateContentSignature;
 interface UpdateContentSignature {
     /**
-     * Updates a Content.
-     * @param - Content ID.
-     * @returns Updated Content.
+     * Updates a translation content item.
+     *
+     * To remove a field, pass the field key with an empty object as the value. For example:
+     *
+     * ```json
+     * "fields": {
+     * "title": {}
+     * }
+     * ```
+     * @param - Translation content ID.
+     * @returns Updated translation content.
      */
     (_id: string | null, content: UpdateContent): Promise<Content & ContentNonNullableFields>;
 }
 declare function updateContentByKey$1(httpClient: HttpClient): UpdateContentByKeySignature;
 interface UpdateContentByKeySignature {
     /**
-     * Updates a Content. A content is identified by a unique key, a combination of (schemaId, entityId, locale)
+     * Updates a translation content item by key.
+     *
+     * To remove a field, pass the field key with an empty object as the value. For example:
+     *
+     * ```js
+     * "fields": {
+     * "title": {}
+     * }
+     * ```
      * @param - Content to be updated, may be partial.
      */
     (content: Content): Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
@@ -7609,37 +7653,53 @@ interface UpdateContentByKeySignature {
 declare function deleteContent$1(httpClient: HttpClient): DeleteContentSignature;
 interface DeleteContentSignature {
     /**
-     * Deletes a Content.
-     * @param - Id of the Content to delete.
+     * Deletes a translation content item.
+     * @param - ID of the translation content to delete.
      */
     (contentId: string): Promise<void>;
 }
 declare function queryContents$1(httpClient: HttpClient): QueryContentsSignature;
 interface QueryContentsSignature {
     /**
-     * Retrieves a list of Contents, given the provided [paging, filtering, and sorting][1].
+     * Retrieves a list of translation content 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`.
+     *
+     * For field support for filters and sorting, see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/translation-content-supported-filters-sorting-and-search).
+     *
+     * To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
      */
     (options?: QueryContentsOptions | undefined): ContentsQueryBuilder;
 }
 declare function searchContents$1(httpClient: HttpClient): SearchContentsSignature;
 interface SearchContentsSignature {
     /**
-     * Retrieves a list of Contents, given the provided CursorSearch.
+     * 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.
+     *
+     * 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.
+     *
+     * For field support for filters, sorting, and free-text searching see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/translation-content-supported-filters-sorting-and-search).
+     *
+     * To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
      */
     (options?: SearchContentsOptions | undefined): Promise<SearchContentsResponse & SearchContentsResponseNonNullableFields>;
 }
 declare function bulkCreateContent$1(httpClient: HttpClient): BulkCreateContentSignature;
 interface BulkCreateContentSignature {
     /**
-     * create multiple Contents in a single request. Works synchronously.
-     * @param - List of Contents to be created TODO: think again if we want to increase maxSize
+     * Creates multiple translation content items.
+     *
+     * The content items are validated based on the constraints defined in the corresponding schema.
+     * @param - List of translation content.
      */
     (contents: Content[], options?: BulkCreateContentOptions | undefined): Promise<BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields>;
 }
 declare function bulkUpdateContent$1(httpClient: HttpClient): BulkUpdateContentSignature;
 interface BulkUpdateContentSignature {
     /**
-     * update multiple Contents in a single request. Works synchronously.
+     * Updates multiple translation content items.
      * @param - Contents to be updated. TODO: think again if we want to increase maxSize
      */
     (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions | undefined): Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
@@ -7655,7 +7715,7 @@ interface BulkUpdateContentByKeySignature {
 declare function bulkDeleteContent$1(httpClient: HttpClient): BulkDeleteContentSignature;
 interface BulkDeleteContentSignature {
     /**
-     * deletes multiple Contents in a single request. Works synchronously.
+     * Deletes multiple translation content items.
      * @param - Content ids to be deleted. TODO: think again if we want to increase maxSize
      */
     (contentIds: string[]): Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;