@wix/auto_sdk_multilingual_machine-translation 1.0.21 → 1.0.22

package/build/internal/es/{multilingual-machine-v3-translatable-content-machine-translation.universal-Crv8uhBN.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * A translatable content is a unit of content to translate.
  *
@@ -1457,6 +1459,8 @@ declare enum NullValue {
     /** Null value. */
     NULL_VALUE = "NULL_VALUE"
 }
+/** @enumType */
+type NullValueWithLiterals = NullValue | 'NULL_VALUE';
 /**
  * `ListValue` is a wrapper around a repeated field of values.
  *
@@ -1913,12 +1917,111 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
+type MachineTranslateApplicationErrors = {
+    code?: 'NOT_ENOUGH_CREDITS';
+    description?: string;
+    data?: NotEnoughCreditsError;
+} | {
+    code?: 'TEXT_TOO_LONG';
+    description?: string;
+    data?: TextTooLongError;
+} | {
+    code?: 'UNKNOWN_FORMAT';
+    description?: string;
+    data?: UnknownFormatError;
+} | {
+    code?: 'SAME_LANGUAGE_ARGUMENTS';
+    description?: string;
+    data?: SameLanguageArgumentsError;
+};
+type BulkMachineTranslateApplicationErrors = {
+    code?: 'NOT_ENOUGH_CREDITS';
+    description?: string;
+    data?: NotEnoughCreditsError;
+} | {
+    code?: 'SAME_LANGUAGE_ARGUMENTS';
+    description?: string;
+    data?: SameLanguageArgumentsError;
+};
+type TranslatableContentNonNullablePaths = `plainTextContent` | `htmlContent` | `format`;
+/**
+ * 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 balance indicating the number of words available for translation. Successful translation requests reduce 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. You can also call the [Credit Data API](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/introduction)'s [Check Sufficient Credits](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/check-sufficient-credits) method at any time to check whether the site has enough credits to translate the specified number of words.
+ * Wix users can receive additional word credits by [purchasing a translation package](https://support.wix.com/en/article/wix-multilingual-auto-translating-your-site#purchasing-translation-packages) in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) at any time.
+ *
+ * To translate up to 1,000 `translatableContent` units at once, use [Bulk Machine Translate](/machine-translation/bulk-machine-translate).
+ * @param sourceLanguage - Language of the source text to translate.
+ * @public
+ * @requiredField options
+ * @requiredField options.contentToTranslate
+ * @requiredField options.targetLanguage
+ * @requiredField sourceLanguage
+ * @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.machine.v3.MachineTranslation.MachineTranslate
+ */
+declare function machineTranslate(sourceLanguage: SupportedLanguageWithLiterals, options: NonNullablePaths<MachineTranslateOptions, `contentToTranslate` | `targetLanguage`>): Promise<NonNullablePaths<MachineTranslateResponse, {
+    [P in TranslatableContentNonNullablePaths]: `translatedContent.${P}`;
+}[TranslatableContentNonNullablePaths]> & {
+    __applicationErrorsType?: MachineTranslateApplicationErrors;
+}>;
 interface MachineTranslateOptions {
     /** Language to translate text into. */
     targetLanguage: SupportedLanguageWithLiterals;
     /** The content to translate. */
     contentToTranslate: TranslatableContent;
 }
+/**
+ * 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 sourceLanguage - Language of the source text to translate.
+ * @public
+ * @requiredField options.targetLanguage
+ * @requiredField sourceLanguage
+ * @permissionId WIX_MULTILINGUAL.MACHINE_TRANSLATE
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.machine.v3.MachineTranslation.BulkMachineTranslate
+ */
+declare function bulkMachineTranslate(sourceLanguage: SupportedLanguageWithLiterals, options?: NonNullablePaths<BulkMachineTranslateOptions, `targetLanguage`>): Promise<NonNullablePaths<BulkMachineTranslateResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in TranslatableContentNonNullablePaths]: `results.${number}.item.${P}`;
+}[TranslatableContentNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+    __applicationErrorsType?: BulkMachineTranslateApplicationErrors;
+}>;
 interface BulkMachineTranslateOptions {
     /** Language to translate text into. */
     targetLanguage: SupportedLanguageWithLiterals;
@@ -1930,4 +2033,4 @@ interface BulkMachineTranslateOptions {
     contentToTranslate?: TranslatableContent[];
 }
 
-export { type LinkDataOneOf as $, Alignment as A, type BulkMachineTranslateOptions as B, Crop as C, DecorationType as D, type ButtonData as E, Format as F, GIFType as G, type Border as H, InitialExpandedItems as I, type Colors as J, type PluginContainerData as K, LineStyle as L, type MachineTranslateOptions as M, NodeType as N, Orientation as O, PluginContainerDataAlignment as P, type PluginContainerDataWidth as Q, type RichContent as R, type SupportedLanguageWithLiterals as S, Type as T, type PluginContainerDataWidthDataOneOf as U, ViewMode as V, WidthType as W, type Spoiler as X, type Height as Y, type Styles as Z, type Link as _, type MachineTranslateResponse as a, type TableData as a$, type Rel as a0, type CodeBlockData as a1, type TextStyle as a2, type DividerData as a3, type FileData as a4, type FileSource as a5, type FileSourceDataOneOf as a6, type PDFSettings as a7, type GalleryData as a8, type Media as a9, type OptionLayout as aA, type Gradient as aB, type Background as aC, type BackgroundBackgroundOneOf as aD, type PollDesign as aE, type OptionDesign as aF, type Poll as aG, type PollDataLayout as aH, type Design as aI, type TextData as aJ, type Decoration as aK, type DecorationDataOneOf as aL, type AnchorData as aM, type ColorData as aN, type LinkData as aO, type MentionData as aP, type FontSizeData as aQ, type SpoilerData as aR, type AppEmbedData as aS, type AppEmbedDataAppDataOneOf as aT, type BookingData as aU, type EventData as aV, type VideoData as aW, type PlaybackOptions as aX, type EmbedData as aY, type Oembed as aZ, type CollapsibleListData as a_, type Image as aa, type Video as ab, type Item as ac, type ItemDataOneOf as ad, type GalleryOptions as ae, type Layout as af, type ItemStyle as ag, type Thumbnails as ah, type GIFData as ai, type GIF as aj, type HeadingData as ak, type HTMLData as al, type HTMLDataDataOneOf as am, type ImageData as an, type StylesBorder as ao, type ImageDataStyles as ap, type LinkPreviewData as aq, type LinkPreviewDataStyles as ar, type MapData as as, type MapSettings as at, type ParagraphData as au, type PollData as av, type Permissions as aw, type Option as ax, type Settings as ay, type PollLayout as az, type BulkMachineTranslateResponse as b, type Dimensions as b0, type TableCellData as b1, type CellStyle as b2, type BorderColors as b3, type ListValue as b4, type AudioData as b5, type OrderedListData as b6, type BulletedListData as b7, type BlockquoteData as b8, type CaptionData as b9, type LayoutCellData as ba, type Metadata as bb, type DocumentStyle as bc, type TextNodeStyle as bd, type MachineTranslateRequest as be, type NotEnoughCreditsError as bf, type TextTooLongError as bg, type UnknownFormatError as bh, type SameLanguageArgumentsError as bi, type BulkMachineTranslateRequest as bj, type BulkTranslateResult as bk, type ItemMetadata as bl, type ApplicationError as bm, type BulkActionMetadata as bn, Target as c, TextAlignment as d, Width as e, LayoutType as f, ThumbnailsAlignment as g, Source as h, Position as i, MapType as j, ViewRole as k, VoteRole as l, PollLayoutType as m, PollLayoutDirection as n, BackgroundType as o, FontType as p, AppType as q, Direction as r, VerticalAlignment as s, NullValue as t, SupportedLanguage as u, type TranslatableContent as v, type TranslatableContentContentOneOf as w, type Node as x, type NodeDataOneOf as y, type NodeStyle as z };
+export { Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkActionMetadata, type BulkMachineTranslateApplicationErrors, type BulkMachineTranslateOptions, type BulkMachineTranslateRequest, type BulkMachineTranslateResponse, type BulkTranslateResult, type BulletedListData, type ButtonData, type CaptionData, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, Crop, type CropWithLiterals, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, type DocumentStyle, type EmbedData, type EventData, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, Format, type FormatWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type Image, type ImageData, type ImageDataStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type MachineTranslateApplicationErrors, type MachineTranslateOptions, type MachineTranslateRequest, type MachineTranslateResponse, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type Metadata, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, type NotEnoughCreditsError, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type ParagraphData, type Permissions, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, type Rel, type RichContent, type SameLanguageArgumentsError, type Settings, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Styles, type StylesBorder, SupportedLanguage, type SupportedLanguageWithLiterals, type TableCellData, type TableData, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type TextTooLongError, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TranslatableContent, type TranslatableContentContentOneOf, Type, type TypeWithLiterals, type UnknownFormatError, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkMachineTranslate, machineTranslate };