@wix/auto_sdk_rich-content_ricos-documents 1.0.52 → 1.0.54

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse } from './index.typings.js';
-export { Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOriginPresenceOneOf, BannerPosition, BannerPositionWithLiterals, BlockquoteData, BookingData, Border, BorderColors, BorderWidths, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, EmbedData, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, FileData, FileDownloadUrl, FileSource, FileSourceDataOneOf, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlRequest, GenerateFileDownloadUrlResponse, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemStyle, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListItemNodeData, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, ParagraphData, Permissions, Placement, PlacementWithLiterals, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PluginWithLiterals, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Scaling, ScalingWithLiterals, SectionDivider, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, Source, SourceWithLiterals, Spoiler, SpoilerData, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Target, TargetFormat, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, ValidateDocumentRequest, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
+import { ValidateDocumentOptions, ValidateDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlApplicationErrors } from './index.typings.js';
+export { Alignment, AlignmentWithLiterals, AnchorData, Animation, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, AspectRatio, AspectRatioWithLiterals, AudioData, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerOriginPresenceOneOf, BannerPosition, BannerPositionWithLiterals, BlockquoteData, BookingData, Border, BorderColors, BorderWidths, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesType, CardStylesTypeWithLiterals, CellStyle, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, ColorDataBackground, ColorDataBackgroundType, ColorDataBackgroundTypeWithLiterals, Colors, ColumnSize, ColumnSizeWithLiterals, ConvertFromRicosDocumentOptionsOptionsOneOf, ConvertFromRicosDocumentRequest, ConvertFromRicosDocumentRequestOptionsOneOf, ConvertFromRicosDocumentResponseResultOneOf, ConvertToRicosDocumentOptionsSourceOneOf, ConvertToRicosDocumentRequest, ConvertToRicosDocumentRequestSourceOneOf, Crop, CropWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, EmbedData, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, FileData, FileDownloadUrl, FileSource, FileSourceDataOneOf, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GenerateFileDownloadUrlRequest, Gradient, GradientType, GradientTypeWithLiterals, HTMLData, HTMLDataDataOneOf, HeadingData, Height, Image, ImageData, ImageDataCrop, ImageDataStyles, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemStyle, LayerEffect, LayerEffectWithLiterals, Layers, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListItemNodeData, ListStyle, ListStyleWithLiterals, ListValue, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, PDFSettings, ParagraphData, Permissions, Placement, PlacementWithLiterals, PlainTextOptions, PlaybackOptions, Plugin, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, PluginWithLiterals, PointerEffect, PointerEffectType, PointerEffectTypeWithLiterals, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, Rel, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, RibbonStyles, RicosDocumentOptions, RicosDocumentPlaceholder, RicosDocumentViolation, Scaling, ScalingWithLiterals, SectionDivider, Settings, Shape, ShapeData, ShapeDataStyles, ShapeWithLiterals, SketchData, SlotData, SlotDesign, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, Source, SourceWithLiterals, Spoiler, SpoilerData, Stop, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, TableCellData, TableData, Target, TargetFormat, TargetWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TocData, Type, TypeWithLiterals, ValidateDocumentRequest, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
 
 declare function validateDocument$1(httpClient: HttpClient): ValidateDocumentSignature;
 interface ValidateDocumentSignature {
@@ -9,6 +9,8 @@ interface ValidateDocumentSignature {
      *
      * Use the `fixDocument` parameter to include a valid version of your Ricos document in the response.
      * @param - Ricos document to validate.
+     *
+     * Accepts any JSON object, including documents that aren't valid Ricos documents.
      * @param - Options to use when validating the document.
      */
     (document: Record<string, any> | null, options?: ValidateDocumentOptions): Promise<ValidateDocumentResponse>;
@@ -31,9 +33,31 @@ interface ConvertFromRicosDocumentSignature {
      */
     (document: RichContent, targetFormat: TargetFormatWithLiterals, options?: ConvertFromRicosDocumentOptions): Promise<ConvertFromRicosDocumentResponse>;
 }
+declare function generateFileDownloadUrl$1(httpClient: HttpClient): GenerateFileDownloadUrlSignature;
+interface GenerateFileDownloadUrlSignature {
+    /**
+     * Generates a temporary URL for downloading the file referenced by a file node in a Ricos document.
+     *
+     * Specify the file node's `fileData.src.id` as `fileId`. The returned URL downloads the original file
+     * as an attachment and expires after 10 hours. Private files are supported, so you can use this method
+     * to let site visitors download files that aren't publicly accessible.
+     *
+     * The method doesn't check whether the file appears in a specific document. Any file of the site can be
+     * retrieved by its ID, so control which file IDs you expose to site visitors in your app.
+     *
+     * If the file doesn't exist, the method fails with a `MEDIA_RESOURCE_NOT_FOUND` error.
+     * @param - ID of the file, as specified in the file node's `fileData.src.id`.
+     *
+     * Can include a path prefix. For example, `ugd/1a2b3c_4d5e6f.pdf` and `1a2b3c_4d5e6f.pdf` refer to the same file.
+     */
+    (fileId: string): Promise<GenerateFileDownloadUrlResponse & {
+        __applicationErrorsType?: GenerateFileDownloadUrlApplicationErrors;
+    }>;
+}
 
 declare const validateDocument: MaybeContext<BuildRESTFunction<typeof validateDocument$1> & typeof validateDocument$1>;
 declare const convertToRicosDocument: MaybeContext<BuildRESTFunction<typeof convertToRicosDocument$1> & typeof convertToRicosDocument$1>;
 declare const convertFromRicosDocument: MaybeContext<BuildRESTFunction<typeof convertFromRicosDocument$1> & typeof convertFromRicosDocument$1>;
+declare const generateFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFileDownloadUrl$1> & typeof generateFileDownloadUrl$1>;
 
-export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, validateDocument };
+export { ConvertFromRicosDocumentOptions, ConvertFromRicosDocumentResponse, ConvertToRicosDocumentOptions, ConvertToRicosDocumentResponse, GenerateFileDownloadUrlApplicationErrors, GenerateFileDownloadUrlResponse, RichContent, TargetFormatWithLiterals, ValidateDocumentOptions, ValidateDocumentResponse, convertFromRicosDocument, convertToRicosDocument, generateFileDownloadUrl, validateDocument };