@wix/auto_sdk_form-templates_form-templates 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,24 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { ListFormTemplatesOptions, ListFormTemplatesResponse } from './index.typings.js';
+export { AddCustomFields, Address, AddressComponentTypeOptionsOneOf, AddressInfo, AddressLine2, Alignment, AlignmentWithLiterals, AllowedValuesOptions, AnchorData, AndCondition, Animation, AnimationType, AnimationTypeWithLiterals, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, Appointment, AppointmentFormatInfoOneOf, ArrayComponentType, ArrayComponentTypeWithLiterals, ArrayItems, ArrayItemsItemTypeOptionsOneOf, ArrayType, AspectRatio, AspectRatioWithLiterals, AudioData, Availability, Backdrop, BackdropType, BackdropTypeWithLiterals, Background, BackgroundGradient, BackgroundImage, BackgroundType, BackgroundTypeWithLiterals, Banner, BannerPosition, BannerPositionWithLiterals, BlockquoteData, BookingData, BooleanComponentType, BooleanComponentTypeWithLiterals, BooleanType, Border, BorderColors, BorderWidths, BreakPoint, BulletedListData, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardData, CardDataBackground, CardDataBackgroundType, CardDataBackgroundTypeWithLiterals, CardStyles, CardStylesAlignment, CardStylesAlignmentWithLiterals, CardStylesType, CardStylesTypeWithLiterals, CellStyle, ChangeableProperty, ChangeablePropertyWithLiterals, Checkbox, CheckboxGroup, CheckboxListData, CodeBlockData, CollapsibleListData, ColorData, Colors, ColumnSize, ColumnSizeWithLiterals, ComponentType, ComponentTypeWithLiterals, Condition, ConditionNode, ConditionNodeNodeOneOf, ConfirmationLevel, ConfirmationLevelWithLiterals, ContactAutofill, ContactAutofillWithLiterals, ContactField, ContactFieldWithLiterals, CorrectAnswersList, Crop, CropWithLiterals, CustomFieldInfo, CustomFieldsType, CustomFieldsTypeWithLiterals, CustomOption, DateInput, DatePicker, DateRange, DateTimeAdvancedConstraints, DateTimeConstraints, DateTimeInput, DayOfWeek, DayOfWeekWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, DefaultCountryConfig, DefaultCountryConfigOptionsOneOf, DeleteTemplateFields, Design, DesignTarget, DesignTargetWithLiterals, Dimensions, Direction, DirectionWithLiterals, DisplayField, DisplayFieldDisplayFieldTypeOptionsOneOf, DisplayFieldType, DisplayFieldTypeWithLiterals, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DividerDataStyles, DocumentStyle, DonationInput, DonationInputOption, Dropdown, DropdownOption, DynamicPriceOptions, EditableFields, EditableProperties, EditablePropertiesWithLiterals, EmailInfo, EmailInfoTag, EmailInfoTagWithLiterals, EmailOptions, EmbedData, EntranceAnimation, EntranceEffect, EntranceEffectType, EntranceEffectTypeWithLiterals, EventData, ExtensionDetails, Field, FieldFieldTypeOptionsOneOf, FieldGroup, FieldOverride, FieldOverridePropertyTypeOptionsOneOf, FieldOverrides, FieldType, FieldTypeWithLiterals, FieldsOverrides, FieldsSettings, FileData, FileSource, FileSourceDataOneOf, FileType, FileUpload, FirstDayOfWeek, FirstDayOfWeekWithLiterals, FixedPayment, FixedPriceOptions, FontFamilyData, FontSizeData, FontType, FontTypeWithLiterals, FormFieldContactInfo, FormFieldContactInfoAdditionalInfoOneOf, FormLayout, FormOverride, FormOverrideEntityTypeOptionsOneOf, FormTemplate, FormTemplateTemplateTypeOptionsOneOf, Format, FormatEnumFormat, FormatEnumFormatWithLiterals, FormatWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, Gradient, GradientType, GradientTypeWithLiterals, Group, HTMLData, HTMLDataDataOneOf, HeadingData, Height, HiddenOptions, Image, ImageData, ImageDataCrop, ImageDataStyles, ImageFit, ImageFitWithLiterals, ImagePosition, ImagePositionPosition, ImagePositionPositionWithLiterals, ImagePositionWithLiterals, ImageScalingScaling, ImageScalingScalingWithLiterals, ImageStyles, InPersonOptions, Indentation, IndentationWithLiterals, InitialExpandedItems, InitialExpandedItemsWithLiterals, InputField, InputFieldInputTypeOptionsOneOf, InputType, InputTypeWithLiterals, Item, ItemDataOneOf, ItemLayout, ItemLayoutItemOneOf, ItemStyle, ItemType, ItemTypeWithLiterals, Layout, LayoutCellData, LayoutData, LayoutDataBackground, LayoutDataBackgroundImage, LayoutDataBackgroundType, LayoutDataBackgroundTypeWithLiterals, LayoutDataImagePosition, LayoutDataImagePositionWithLiterals, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineCap, LineCapWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, LinkTarget, LinkTargetWithLiterals, ListFormTemplatesRequest, ListItemNodeData, ListStyle, ListStyleWithLiterals, ListValue, Location, LocationLocationInfoOneOf, LoopAnimation, LoopEffect, LoopEffectType, LoopEffectTypeWithLiterals, MapData, MapSettings, MapType, MapTypeWithLiterals, Margin, Media, MediaItem, MediaItemMediaOneOf, MediaSettings, MeetingType, MeetingTypeWithLiterals, MentionData, Metadata, MultilineAddress, MultilineAddressValidation, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NullValue, NullValueWithLiterals, NumberComponentType, NumberComponentTypeWithLiterals, NumberCorrectAnswersList, NumberInput, NumberOfColumns, NumberOfColumnsWithLiterals, NumberQuizFieldSettings, NumberType, ObjectArray, ObjectArrayComponentType, ObjectArrayComponentTypeOptionsOneOf, ObjectArrayComponentTypeWithLiterals, ObjectArrayType, ObjectType, Oembed, Operator, OperatorWithLiterals, Option, OptionDesign, OptionLayout, OptionsMediaSettings, OrCondition, OrderedListData, Orientation, OrientationWithLiterals, Origin, OriginWithLiterals, OverrideEntityType, OverrideEntityTypeWithLiterals, OverrideTemplateFields, PDFSettings, PageNavigationOptions, ParagraphData, PassFailMessages, Password, Payment, PaymentComponentType, PaymentComponentTypeOptionsOneOf, PaymentComponentTypeWithLiterals, PaymentInput, PaymentType, Permissions, PhoneConstraints, PhoneInfo, PhoneInfoTag, PhoneInfoTagWithLiterals, PhoneInput, PhoneOptions, Placement, PlacementWithLiterals, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollDesignBackground, PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, PollDesignBackgroundTypeWithLiterals, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, PollOption, PopupOptions, Position, PositionWithLiterals, PriceType, PriceTypeWithLiterals, PricingData, Product, ProductCheckboxGroup, ProductCheckboxGroupOption, ProductPriceOptionsOneOf, ProductType, ProductTypeWithLiterals, PropertiesType, PropertiesTypeEnum, PropertiesTypeEnumWithLiterals, PropertiesTypePropertiesTypeOptionsOneOf, QuantityLimit, QuizFieldSettings, QuizSettings, QuizSettingsPassingCriteriaOneOf, QuizSettingsResultsDisplayOptionsOneOf, RadioGroup, RadioGroupOption, RatingInput, RebookingPolicy, RebookingPolicyOptionsOneOf, RedirectOptions, Rel, Repeater, RequiredIndicator, RequiredIndicatorPlacement, RequiredIndicatorPlacementWithLiterals, RequiredIndicatorProperties, RequiredIndicatorWithLiterals, RequiredOptions, Resizing, ResizingWithLiterals, ResponsivenessBehaviour, ResponsivenessBehaviourWithLiterals, ResultsDisplay, ResultsDisplayWithLiterals, RibbonStyles, RichContent, RichContentOptions, Rule, Scaling, ScalingWithLiterals, Scheduling, SchedulingComponentType, SchedulingComponentTypeOptionsOneOf, SchedulingComponentTypeWithLiterals, Section, ServiceOption, ServicesCheckboxGroup, ServicesDropdown, Settings, ShapeData, ShapeDataStyles, Signature, SketchData, SmartBlockCellData, SmartBlockData, SmartBlockDataType, SmartBlockDataTypeWithLiterals, Source, SourceWithLiterals, Spoiler, SpoilerData, StaffStrategySelection, StaffStrategySelectionWithLiterals, Step, Stop, StringComponentType, StringComponentTypeWithLiterals, StringCorrectAnswersList, StringQuizFieldSettings, StringType, StringTypeFormatOptionsOneOf, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, SubmitSettings, SubmitSettingsSubmitSuccessActionOptionsOneOf, SubmitSuccessAction, SubmitSuccessActionWithLiterals, SubscriptionChannel, SubscriptionChannelWithLiterals, SubscriptionInfo, TableCellData, TableData, Tag, TagWithLiterals, Tags, TagsOption, Target, TargetWithLiterals, TemplateType, TemplateTypeWithLiterals, TextAlignment, TextAlignmentWithLiterals, TextData, TextInput, TextInputSemanticOptionsOneOf, TextNodeStyle, TextStyle, ThankYouMessageOptions, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TimeInput, TocData, Type, TypeWithLiterals, UploadFileFormat, UploadFileFormatWithLiterals, ValidationMessages, Variant, VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, VerticalAlignmentAlignmentWithLiterals, VerticalAlignmentWithLiterals, Video, VideoConferenceOptions, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WaitOptions, WaitType, WaitTypeWithLiterals, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals, WixFile, WixFileComponentType, WixFileComponentTypeOptionsOneOf, WixFileComponentTypeWithLiterals, _Array, _ArrayComponentTypeOptionsOneOf, _Boolean, _BooleanComponentTypeOptionsOneOf, _Number, _NumberComponentTypeOptionsOneOf, _Object, _String, _StringComponentTypeOptionsOneOf } from './index.typings.js';
+
+declare function listFormTemplates$1(httpClient: HttpClient): ListFormTemplatesSignature;
+interface ListFormTemplatesSignature {
+    /**
+     * Retrieves the form templates in a namespace, optionally filtered by template IDs.
+     *
+     * Templates are returned only for apps installed on the site, together with templates from apps made
+     * by Wix. If the app that owns the namespace isn't installed on the site, the response is empty.
+     *
+     * Returned template content, such as field labels, is served in the language resolved from the request.
+     * @param - Namespace whose templates to retrieve. A namespace groups the templates and forms that belong to
+     * the same app or use case, such as a bookings or pricing plans checkout. The value is defined by
+     * the app that owns the templates in the app dashboard.
+     * @returns Templates per namespace are hard-limited to a single page (AIP-4003), so the response isn't paged.
+     */
+    (namespace: string, options?: ListFormTemplatesOptions): Promise<NonNullablePaths<ListFormTemplatesResponse, `templates` | `templates.${number}.namespace` | `templates.${number}.submitSettings.redirectOptions.target` | `templates.${number}.submitSettings.popupOptions.popupId` | `templates.${number}.submitSettings.submitSuccessAction` | `templates.${number}.requiredIndicatorProperties.requiredIndicator` | `templates.${number}.requiredIndicatorProperties.requiredIndicatorPlacement` | `templates.${number}.autoFillContact` | `templates.${number}.quizSettings.passingScorePoints` | `templates.${number}.quizSettings.passingScorePercentage` | `templates.${number}.quizSettings.resultsDisplay`, 6>>;
+}
+
+declare const listFormTemplates: MaybeContext<BuildRESTFunction<typeof listFormTemplates$1> & typeof listFormTemplates$1>;
+
+export { ListFormTemplatesOptions, ListFormTemplatesResponse, listFormTemplates };