@wix/multilingual 1.0.27 → 1.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/multilingual",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,12 +18,12 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/multilingual_entity-mapper": "1.0.2",
-    "@wix/multilingual_machine-translation": "1.0.22",
-    "@wix/multilingual_site-translator": "1.0.9",
-    "@wix/multilingual_translation-contents": "1.0.11",
-    "@wix/multilingual_translation-published-contents": "1.0.0",
-    "@wix/multilingual_translation-schemas": "1.0.10"
+    "@wix/multilingual_entity-mapper": "1.0.3",
+    "@wix/multilingual_machine-translation": "1.0.23",
+    "@wix/multilingual_site-translator": "1.0.10",
+    "@wix/multilingual_translation-contents": "1.0.12",
+    "@wix/multilingual_translation-published-contents": "1.0.1",
+    "@wix/multilingual_translation-schemas": "1.0.11"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "f581a7e16662ba95442f9c432883446d00819884f507ecb24f40e97f"
+  "falconPackageHash": "892e8420b797e2d661c85802b99e96af98744575d09b71e2168e6614"
 }

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

@@ -460,7 +460,13 @@ interface SyncEditorDataOptions {
     syncFilter?: SyncFilter;
 }
 
-declare function syncEditorData$1(httpClient: HttpClient): (options?: SyncEditorDataOptions) => Promise<void>;
+declare function syncEditorData$1(httpClient: HttpClient): SyncEditorDataSignature;
+interface SyncEditorDataSignature {
+    /**
+     * Update localization content with editor data
+     */
+    (options?: SyncEditorDataOptions | undefined): Promise<void>;
+}
 
 declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -2362,7 +2368,13 @@ interface PublishedContentQueryBuilder {
     find: () => Promise<PublishedContentQueryResult>;
 }
 
-declare function queryPublishedContent$1(httpClient: HttpClient): () => PublishedContentQueryBuilder;
+declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
+interface QueryPublishedContentSignature {
+    /**
+     * Query the published content of multiple entities using the schema key and optionally other criteria
+     */
+    (): PublishedContentQueryBuilder;
+}
 
 declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -4283,8 +4295,62 @@ interface BulkMachineTranslateOptions {
     contentToTranslate?: TranslatableContent[];
 }
 
-declare function machineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions) => Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
-declare function bulkMachineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions) => Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
+declare function machineTranslate$1(httpClient: HttpClient): MachineTranslateSignature;
+interface MachineTranslateSignature {
+    /**
+     * Translates the text of a translatable unit of content from one supported language to another.
+     *
+     * The `translatedContent` object returns with the same `id` used for `contentToTranslate.id` but the text within the
+     * content fields is replaced with the translated text. Note that Wix does not overwrite the original content object.
+     * To retrieve the translated content later, make sure to store it separately.
+     *
+     * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
+     * cannot be translated using this method.
+     *
+     * The translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
+     * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
+     * The total translatable content may be more than 5,000 characters as long as no individual node surpasses this limit.
+     * If any node exceeds 5,000 characters, the entire request fails.
+     *
+     * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
+     * Each successful translation request reduces the word credits by the number of words in `contentToTranslate`.
+     * If the site does not have sufficient word credits to translate all of the text in the request, the request fails
+     * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
+     *
+     * To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
+     * @param - Language of the source text to translate.
+     */
+    (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions): Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
+}
+declare function bulkMachineTranslate$1(httpClient: HttpClient): BulkMachineTranslateSignature;
+interface BulkMachineTranslateSignature {
+    /**
+     * Translates the text of multiple units of translatable content from one supported language to another.
+     *
+     * Each translated content item in the `results` array returns with the same `id` as the corresponding `contentToTranslate.id`, but with the text in the
+     * content fields replaced with the translated text. Note that Wix does not overwrite the original content source,
+     * to retrieve the translated content later, make sure to store it separately.
+     *
+     * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
+     * cannot be translated using this method.
+     *
+     * Each unit of translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
+     * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
+     * The total request may exceed 5,000 characters as long as no individual node surpasses this limit.
+     * If any node exceeds 5,000 characters, then the request fails for that specific `contentToTranslate` item and the error details for that
+     * error are returned in `itemMetadata`. Even if some translations fail due to the character limit,
+     * the machine translation for other items will succeed if they are under the character limit.
+     *
+     * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
+     * Each successful translation request reduces the word credits by the number of words included in `contentToTranslate`.
+     * If the site does not have sufficient word credits to complete the translation, then the entire request fails
+     * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
+     *
+     * To translate a single unit of `translatableContent`, use [Machine Translate](/machine-translation/machine-translate).
+     * @param - Language of the source text to translate.
+     */
+    (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions | undefined): Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
+}
 
 declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -4640,8 +4706,22 @@ interface GetSiteTranslatablesPropertiesOptions {
     translatedLanguage?: Locale;
 }
 
-declare function translateSite$1(httpClient: HttpClient): (mainLanguage: Locale, options: TranslateSiteOptions) => Promise<void>;
-declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions) => Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
+declare function translateSite$1(httpClient: HttpClient): TranslateSiteSignature;
+interface TranslateSiteSignature {
+    /**
+     * Start a task to auto-translate all site content that hasn't been translated yet
+     * @param - Language from which the site content is translated
+     */
+    (mainLanguage: Locale, options: TranslateSiteOptions): Promise<void>;
+}
+declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): GetSiteTranslatablesPropertiesSignature;
+interface GetSiteTranslatablesPropertiesSignature {
+    /**
+     * Receive the site's translation status
+     * @param - Number of words included in main_language
+     */
+    (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions | undefined): Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
+}
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -6101,7 +6181,7 @@ interface QueryContentsResponse {
     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;
@@ -6177,6 +6257,7 @@ interface PagingMetadataV2 {
     cursors?: Cursors$1;
 }
 interface SearchContentsRequest {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -7335,6 +7416,7 @@ interface ContentsQueryBuilder {
     find: () => Promise<ContentsQueryResult>;
 }
 interface SearchContentsOptions {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch;
 }
 interface BulkCreateContentOptions {
@@ -7350,17 +7432,97 @@ interface BulkUpdateContentByKeyOptions {
     returnEntity?: boolean;
 }
 
-declare function createContent$1(httpClient: HttpClient): (content: Content) => Promise<Content & ContentNonNullableFields>;
-declare function getContent$1(httpClient: HttpClient): (contentId: string) => Promise<Content & ContentNonNullableFields>;
-declare function updateContent$1(httpClient: HttpClient): (_id: string | null, content: UpdateContent) => Promise<Content & ContentNonNullableFields>;
-declare function updateContentByKey$1(httpClient: HttpClient): (content: Content) => Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
-declare function deleteContent$1(httpClient: HttpClient): (contentId: string) => Promise<void>;
-declare function queryContents$1(httpClient: HttpClient): (options?: QueryContentsOptions) => ContentsQueryBuilder;
-declare function searchContents$1(httpClient: HttpClient): (options?: SearchContentsOptions) => Promise<SearchContentsResponse & SearchContentsResponseNonNullableFields>;
-declare function bulkCreateContent$1(httpClient: HttpClient): (contents: Content[], options?: BulkCreateContentOptions) => Promise<BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields>;
-declare function bulkUpdateContent$1(httpClient: HttpClient): (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions) => Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
-declare function bulkUpdateContentByKey$1(httpClient: HttpClient): (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions) => Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
-declare function bulkDeleteContent$1(httpClient: HttpClient): (contentIds: string[]) => Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
+declare function createContent$1(httpClient: HttpClient): CreateContentSignature;
+interface CreateContentSignature {
+    /**
+     * Creates a Content.
+     *
+     * The request body must include schema-id, entity-id and locale.
+     * @param - Content to be created.
+     * @returns The created 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.
+     */
+    (contentId: string): Promise<Content & ContentNonNullableFields>;
+}
+declare function updateContent$1(httpClient: HttpClient): UpdateContentSignature;
+interface UpdateContentSignature {
+    /**
+     * Updates a Content.
+     * @param - Content ID.
+     * @returns Updated 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)
+     * @param - Content to be updated, may be partial.
+     */
+    (content: Content): Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
+}
+declare function deleteContent$1(httpClient: HttpClient): DeleteContentSignature;
+interface DeleteContentSignature {
+    /**
+     * Deletes a Content.
+     * @param - Id of the 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].
+     */
+    (options?: QueryContentsOptions | undefined): ContentsQueryBuilder;
+}
+declare function searchContents$1(httpClient: HttpClient): SearchContentsSignature;
+interface SearchContentsSignature {
+    /**
+     * Retrieves a list of Contents, given the provided CursorSearch.
+     */
+    (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
+     */
+    (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.
+     * @param - Contents to be updated. TODO: think again if we want to increase maxSize
+     */
+    (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions | undefined): Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
+}
+declare function bulkUpdateContentByKey$1(httpClient: HttpClient): 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
+     */
+    (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions | undefined): Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
+}
+declare function bulkDeleteContent$1(httpClient: HttpClient): BulkDeleteContentSignature;
+interface BulkDeleteContentSignature {
+    /**
+     * deletes multiple Contents in a single request. Works synchronously.
+     * @param - Content ids to be deleted. TODO: think again if we want to increase maxSize
+     */
+    (contentIds: string[]): Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
+}
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -8439,10 +8601,36 @@ interface ListSiteSchemasOptions {
     paging?: CursorPaging;
 }
 
-declare function getSchema$1(httpClient: HttpClient): (schemaId: string) => Promise<Schema & SchemaNonNullableFields>;
-declare function getSchemaByKey$1(httpClient: HttpClient): (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey) => Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
-declare function querySchemas$1(httpClient: HttpClient): (options?: QuerySchemasOptions) => SchemasQueryBuilder;
-declare function listSiteSchemas$1(httpClient: HttpClient): (options?: ListSiteSchemasOptions) => Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
+declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
+interface GetSchemaSignature {
+    /**
+     * Retrieves a Schema.
+     * @param - ID of the Schema to retrieve.
+     * @returns The requested Schema.
+     */
+    (schemaId: string): Promise<Schema & SchemaNonNullableFields>;
+}
+declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
+interface GetSchemaByKeySignature {
+    /**
+     * Retrieves a Schema by key.
+     */
+    (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
+}
+declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
+interface QuerySchemasSignature {
+    /**
+     * Retrieves a list of Schemas, given the provided [paging, filtering, and sorting][1].
+     */
+    (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
+}
+declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
+interface ListSiteSchemasSignature {
+    /**
+     * Retrieves a list of Schemas of app installed on site.
+     */
+    (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
+}
 declare const onSchemaCreated$1: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
 declare const onSchemaUpdated$1: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
 declare const onSchemaDeleted$1: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
@@ -8461,12 +8649,15 @@ type _publicListSiteSchemasType = typeof listSiteSchemas$1;
 declare const listSiteSchemas: ReturnType<typeof createRESTModule<_publicListSiteSchemasType>>;
 
 type _publicOnSchemaCreatedType = typeof onSchemaCreated$1;
+/** */
 declare const onSchemaCreated: ReturnType<typeof createEventModule<_publicOnSchemaCreatedType>>;
 
 type _publicOnSchemaUpdatedType = typeof onSchemaUpdated$1;
+/** */
 declare const onSchemaUpdated: ReturnType<typeof createEventModule<_publicOnSchemaUpdatedType>>;
 
 type _publicOnSchemaDeletedType = typeof onSchemaDeleted$1;
+/** */
 declare const onSchemaDeleted: ReturnType<typeof createEventModule<_publicOnSchemaDeletedType>>;
 
 type context_ActionEvent = ActionEvent;

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

@@ -460,7 +460,13 @@ interface SyncEditorDataOptions {
     syncFilter?: SyncFilter;
 }
 
-declare function syncEditorData$1(httpClient: HttpClient): (options?: SyncEditorDataOptions) => Promise<void>;
+declare function syncEditorData$1(httpClient: HttpClient): SyncEditorDataSignature;
+interface SyncEditorDataSignature {
+    /**
+     * Update localization content with editor data
+     */
+    (options?: SyncEditorDataOptions | undefined): Promise<void>;
+}
 
 declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -2362,7 +2368,13 @@ interface PublishedContentQueryBuilder {
     find: () => Promise<PublishedContentQueryResult>;
 }
 
-declare function queryPublishedContent$1(httpClient: HttpClient): () => PublishedContentQueryBuilder;
+declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
+interface QueryPublishedContentSignature {
+    /**
+     * Query the published content of multiple entities using the schema key and optionally other criteria
+     */
+    (): PublishedContentQueryBuilder;
+}
 
 declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -4283,8 +4295,62 @@ interface BulkMachineTranslateOptions {
     contentToTranslate?: TranslatableContent[];
 }
 
-declare function machineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions) => Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
-declare function bulkMachineTranslate$1(httpClient: HttpClient): (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions) => Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
+declare function machineTranslate$1(httpClient: HttpClient): MachineTranslateSignature;
+interface MachineTranslateSignature {
+    /**
+     * Translates the text of a translatable unit of content from one supported language to another.
+     *
+     * The `translatedContent` object returns with the same `id` used for `contentToTranslate.id` but the text within the
+     * content fields is replaced with the translated text. Note that Wix does not overwrite the original content object.
+     * To retrieve the translated content later, make sure to store it separately.
+     *
+     * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
+     * cannot be translated using this method.
+     *
+     * The translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
+     * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
+     * The total translatable content may be more than 5,000 characters as long as no individual node surpasses this limit.
+     * If any node exceeds 5,000 characters, the entire request fails.
+     *
+     * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
+     * Each successful translation request reduces the word credits by the number of words in `contentToTranslate`.
+     * If the site does not have sufficient word credits to translate all of the text in the request, the request fails
+     * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
+     *
+     * To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
+     * @param - Language of the source text to translate.
+     */
+    (sourceLanguage: SupportedLanguage, options: MachineTranslateOptions): Promise<MachineTranslateResponse & MachineTranslateResponseNonNullableFields>;
+}
+declare function bulkMachineTranslate$1(httpClient: HttpClient): BulkMachineTranslateSignature;
+interface BulkMachineTranslateSignature {
+    /**
+     * Translates the text of multiple units of translatable content from one supported language to another.
+     *
+     * Each translated content item in the `results` array returns with the same `id` as the corresponding `contentToTranslate.id`, but with the text in the
+     * content fields replaced with the translated text. Note that Wix does not overwrite the original content source,
+     * to retrieve the translated content later, make sure to store it separately.
+     *
+     * Only text content is translated, even if the content is `htmlContent` or `richContent`. Note that [collapsible text](https://support.wix.com/en/article/adding-and-setting-up-collapsible-text)
+     * cannot be translated using this method.
+     *
+     * Each unit of translatable content must not exceed 5,000 characters. If this limit is exceeded, the method returns a `TEXT_TOO_LONG` error.
+     * For `richContent`, the 5,000-character limit applies separately to each node in `richContent.nodes`.
+     * The total request may exceed 5,000 characters as long as no individual node surpasses this limit.
+     * If any node exceeds 5,000 characters, then the request fails for that specific `contentToTranslate` item and the error details for that
+     * error are returned in `itemMetadata`. Even if some translations fail due to the character limit,
+     * the machine translation for other items will succeed if they are under the character limit.
+     *
+     * Each site has a [word credit](/machine-translation/introduction#terminology) balance, starting at 3,000 words.
+     * Each successful translation request reduces the word credits by the number of words included in `contentToTranslate`.
+     * If the site does not have sufficient word credits to complete the translation, then the entire request fails
+     * with a `NOT_ENOUGH_CREDITS` error. Additional credits can be [purchased through the Dashboard](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site?tabs=Dashboard-5#purchasing-translation-packages).
+     *
+     * To translate a single unit of `translatableContent`, use [Machine Translate](/machine-translation/machine-translate).
+     * @param - Language of the source text to translate.
+     */
+    (sourceLanguage: SupportedLanguage, options?: BulkMachineTranslateOptions | undefined): Promise<BulkMachineTranslateResponse & BulkMachineTranslateResponseNonNullableFields>;
+}
 
 declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -4640,8 +4706,22 @@ interface GetSiteTranslatablesPropertiesOptions {
     translatedLanguage?: Locale;
 }
 
-declare function translateSite$1(httpClient: HttpClient): (mainLanguage: Locale, options: TranslateSiteOptions) => Promise<void>;
-declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions) => Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
+declare function translateSite$1(httpClient: HttpClient): TranslateSiteSignature;
+interface TranslateSiteSignature {
+    /**
+     * Start a task to auto-translate all site content that hasn't been translated yet
+     * @param - Language from which the site content is translated
+     */
+    (mainLanguage: Locale, options: TranslateSiteOptions): Promise<void>;
+}
+declare function getSiteTranslatablesProperties$1(httpClient: HttpClient): GetSiteTranslatablesPropertiesSignature;
+interface GetSiteTranslatablesPropertiesSignature {
+    /**
+     * Receive the site's translation status
+     * @param - Number of words included in main_language
+     */
+    (mainLanguage: Locale, options?: GetSiteTranslatablesPropertiesOptions | undefined): Promise<GetSiteTranslatablesPropertiesResponse & GetSiteTranslatablesPropertiesResponseNonNullableFields>;
+}
 
 declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -6101,7 +6181,7 @@ interface QueryContentsResponse {
     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;
@@ -6177,6 +6257,7 @@ interface PagingMetadataV2 {
     cursors?: Cursors$1;
 }
 interface SearchContentsRequest {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {
@@ -7335,6 +7416,7 @@ interface ContentsQueryBuilder {
     find: () => Promise<ContentsQueryResult>;
 }
 interface SearchContentsOptions {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch;
 }
 interface BulkCreateContentOptions {
@@ -7350,17 +7432,97 @@ interface BulkUpdateContentByKeyOptions {
     returnEntity?: boolean;
 }
 
-declare function createContent$1(httpClient: HttpClient): (content: Content) => Promise<Content & ContentNonNullableFields>;
-declare function getContent$1(httpClient: HttpClient): (contentId: string) => Promise<Content & ContentNonNullableFields>;
-declare function updateContent$1(httpClient: HttpClient): (_id: string | null, content: UpdateContent) => Promise<Content & ContentNonNullableFields>;
-declare function updateContentByKey$1(httpClient: HttpClient): (content: Content) => Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
-declare function deleteContent$1(httpClient: HttpClient): (contentId: string) => Promise<void>;
-declare function queryContents$1(httpClient: HttpClient): (options?: QueryContentsOptions) => ContentsQueryBuilder;
-declare function searchContents$1(httpClient: HttpClient): (options?: SearchContentsOptions) => Promise<SearchContentsResponse & SearchContentsResponseNonNullableFields>;
-declare function bulkCreateContent$1(httpClient: HttpClient): (contents: Content[], options?: BulkCreateContentOptions) => Promise<BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields>;
-declare function bulkUpdateContent$1(httpClient: HttpClient): (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions) => Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
-declare function bulkUpdateContentByKey$1(httpClient: HttpClient): (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions) => Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
-declare function bulkDeleteContent$1(httpClient: HttpClient): (contentIds: string[]) => Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
+declare function createContent$1(httpClient: HttpClient): CreateContentSignature;
+interface CreateContentSignature {
+    /**
+     * Creates a Content.
+     *
+     * The request body must include schema-id, entity-id and locale.
+     * @param - Content to be created.
+     * @returns The created 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.
+     */
+    (contentId: string): Promise<Content & ContentNonNullableFields>;
+}
+declare function updateContent$1(httpClient: HttpClient): UpdateContentSignature;
+interface UpdateContentSignature {
+    /**
+     * Updates a Content.
+     * @param - Content ID.
+     * @returns Updated 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)
+     * @param - Content to be updated, may be partial.
+     */
+    (content: Content): Promise<UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields>;
+}
+declare function deleteContent$1(httpClient: HttpClient): DeleteContentSignature;
+interface DeleteContentSignature {
+    /**
+     * Deletes a Content.
+     * @param - Id of the 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].
+     */
+    (options?: QueryContentsOptions | undefined): ContentsQueryBuilder;
+}
+declare function searchContents$1(httpClient: HttpClient): SearchContentsSignature;
+interface SearchContentsSignature {
+    /**
+     * Retrieves a list of Contents, given the provided CursorSearch.
+     */
+    (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
+     */
+    (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.
+     * @param - Contents to be updated. TODO: think again if we want to increase maxSize
+     */
+    (contents: BulkUpdateContentRequestMaskedContent[], options?: BulkUpdateContentOptions | undefined): Promise<BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields>;
+}
+declare function bulkUpdateContentByKey$1(httpClient: HttpClient): 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
+     */
+    (contents: MaskedContent[], options?: BulkUpdateContentByKeyOptions | undefined): Promise<BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields>;
+}
+declare function bulkDeleteContent$1(httpClient: HttpClient): BulkDeleteContentSignature;
+interface BulkDeleteContentSignature {
+    /**
+     * deletes multiple Contents in a single request. Works synchronously.
+     * @param - Content ids to be deleted. TODO: think again if we want to increase maxSize
+     */
+    (contentIds: string[]): Promise<BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields>;
+}
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
@@ -8439,10 +8601,36 @@ interface ListSiteSchemasOptions {
     paging?: CursorPaging;
 }
 
-declare function getSchema$1(httpClient: HttpClient): (schemaId: string) => Promise<Schema & SchemaNonNullableFields>;
-declare function getSchemaByKey$1(httpClient: HttpClient): (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey) => Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
-declare function querySchemas$1(httpClient: HttpClient): (options?: QuerySchemasOptions) => SchemasQueryBuilder;
-declare function listSiteSchemas$1(httpClient: HttpClient): (options?: ListSiteSchemasOptions) => Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
+declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
+interface GetSchemaSignature {
+    /**
+     * Retrieves a Schema.
+     * @param - ID of the Schema to retrieve.
+     * @returns The requested Schema.
+     */
+    (schemaId: string): Promise<Schema & SchemaNonNullableFields>;
+}
+declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
+interface GetSchemaByKeySignature {
+    /**
+     * Retrieves a Schema by key.
+     */
+    (identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
+}
+declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
+interface QuerySchemasSignature {
+    /**
+     * Retrieves a list of Schemas, given the provided [paging, filtering, and sorting][1].
+     */
+    (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
+}
+declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
+interface ListSiteSchemasSignature {
+    /**
+     * Retrieves a list of Schemas of app installed on site.
+     */
+    (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields>;
+}
 declare const onSchemaCreated$1: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
 declare const onSchemaUpdated$1: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
 declare const onSchemaDeleted$1: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
@@ -8461,12 +8649,15 @@ type _publicListSiteSchemasType = typeof listSiteSchemas$1;
 declare const listSiteSchemas: ReturnType<typeof createRESTModule<_publicListSiteSchemasType>>;
 
 type _publicOnSchemaCreatedType = typeof onSchemaCreated$1;
+/** */
 declare const onSchemaCreated: ReturnType<typeof createEventModule<_publicOnSchemaCreatedType>>;
 
 type _publicOnSchemaUpdatedType = typeof onSchemaUpdated$1;
+/** */
 declare const onSchemaUpdated: ReturnType<typeof createEventModule<_publicOnSchemaUpdatedType>>;
 
 type _publicOnSchemaDeletedType = typeof onSchemaDeleted$1;
+/** */
 declare const onSchemaDeleted: ReturnType<typeof createEventModule<_publicOnSchemaDeletedType>>;
 
 type index_d_ActionEvent = ActionEvent;

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

@@ -9245,7 +9245,7 @@ interface QueryContentsResponse$1 {
     pagingMetadata?: CursorPagingMetadata$3;
 }
 interface CursorPagingMetadata$3 {
-    /** 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$3;
@@ -9264,6 +9264,7 @@ interface Cursors$3 {
     prev?: string | null;
 }
 interface SearchContentsRequest$1 {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch$1;
 }
 interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
@@ -11315,7 +11316,7 @@ interface QueryContentsResponse {
     pagingMetadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {
-    /** 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$2;
@@ -11334,6 +11335,7 @@ interface Cursors$2 {
     prev?: string | null;
 }
 interface SearchContentsRequest {
+    /** WQL expression, Aggregation and Search */
     search?: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {