@wix/forms 1.0.184 → 1.0.186

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

@@ -2751,14 +2751,6 @@ interface InputFieldMultilineAddressComponentTypeOptionsOneOf$1 {
     /** Multiline address input field. */
     multilineAddressOptions?: MultilineAddress$1;
 }
-interface Header$1 {
-    /** Content of the header */
-    content?: RichContent$1;
-}
-interface RichText$1 {
-    /** Content of the rich text field */
-    content?: RichContent$1;
-}
 declare enum Target$1 {
     /** Undefined target. */
     UNDEFINED = "UNDEFINED",
@@ -2849,11 +2841,25 @@ interface InputFieldInputTypeOptionsOneOf$1 {
     /** Input returns multiline address as value. */
     multilineAddressOptions?: InputFieldMultilineAddress$1;
 }
-interface DisplayField$1 extends DisplayFieldComponentTypeOneOf$1 {
+/** Copy of the entity existing in form template project, needed to hide translations. */
+interface DisplayField$1 extends DisplayFieldDisplayFieldTypeOptionsOneOf$1, DisplayFieldComponentTypeOneOf$1 {
+    /** Component displaying rich content */
+    richContentOptions?: RichContentOptions$1;
+    /** Page navigation component resolving as navigation or submit buttons */
+    pageNavigationOptions?: PageNavigationOptions$1;
     /** Header field */
     header?: Header$1;
     /** Rich text field */
     richText?: RichText$1;
+    /** Type of the display field */
+    displayFieldType?: DisplayFieldType$1;
+}
+/** @oneof */
+interface DisplayFieldDisplayFieldTypeOptionsOneOf$1 {
+    /** Component displaying rich content */
+    richContentOptions?: RichContentOptions$1;
+    /** Page navigation component resolving as navigation or submit buttons */
+    pageNavigationOptions?: PageNavigationOptions$1;
 }
 /** @oneof */
 interface DisplayFieldComponentTypeOneOf$1 {
@@ -2862,6 +2868,31 @@ interface DisplayFieldComponentTypeOneOf$1 {
     /** Rich text field */
     richText?: RichText$1;
 }
+declare enum DisplayFieldType$1 {
+    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
+    RICH_CONTENT = "RICH_CONTENT",
+    PAGE_NAVIGATION = "PAGE_NAVIGATION"
+}
+interface RichContentOptions$1 {
+    /** Content of the header */
+    richContent?: RichContent$1;
+}
+interface PageNavigationOptions$1 {
+    /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
+    nextPageText?: string | null;
+    /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
+    previousPageText?: string | null;
+    /** Text on the button when button is submitting a form */
+    submitText?: string | null;
+}
+interface Header$1 {
+    /** Content of the header */
+    content?: RichContent$1;
+}
+interface RichText$1 {
+    /** Content of the rich text field */
+    content?: RichContent$1;
+}
 interface SubmitButton$1 extends SubmitButtonSubmitActionOneOf$1 {
     /**
      * Submit action effect is to show message
@@ -3552,6 +3583,67 @@ interface FormProviderRestrictions$1 {
     /** Maximum amount of deleted forms allowed per namespace. */
     maxDeletedFormsAmount?: number | null;
 }
+interface GetFormSummaryRequest$1 {
+    /** Id of the form to retrieve. */
+    formId: string;
+}
+interface GetFormSummaryResponse$1 {
+    /** The retrieved form field summary. */
+    formSummary?: FormSummary$1;
+}
+interface FormSummary$1 {
+    /** Form ID. */
+    id?: string;
+    /** Summarized form fields. */
+    fields?: Field$1[];
+}
+declare enum FieldInputType$1 {
+    UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    RATING = "RATING",
+    BOOLEAN = "BOOLEAN",
+    ARRAY = "ARRAY",
+    OBJECT = "OBJECT",
+    WIX_FILE = "WIX_FILE",
+    SIGNATURE = "SIGNATURE",
+    PAYMENT = "PAYMENT",
+    MULTILINE_ADDRESS = "MULTILINE_ADDRESS",
+    DATE = "DATE",
+    TIME = "TIME",
+    DATE_TIME = "DATE_TIME",
+    EMAIL = "EMAIL",
+    URL = "URL",
+    UUID = "UUID",
+    PHONE = "PHONE",
+    URI = "URI",
+    HOSTNAME = "HOSTNAME",
+    COLOR_HEX = "COLOR_HEX",
+    CURRENCY = "CURRENCY",
+    LANGUAGE = "LANGUAGE",
+    DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
+}
+interface FieldOption$1 {
+    /** Selectable option label */
+    label?: string | null;
+    /** Selectable option value, which is saved to DB. */
+    value?: string | null;
+}
+interface Field$1 {
+    /** Definition of a target where the value of field belongs. */
+    target?: string | null;
+    /** Label of the field */
+    label?: string | null;
+    /** Input type of the field */
+    type?: FieldInputType$1;
+    /** List of options to select from */
+    options?: FieldOption$1[];
+    /**
+     * Flag indicating whether field is deleted.
+     * Default: false.
+     */
+    deleted?: boolean;
+}
 interface PhoneConstraintsNonNullableFields$1 {
     allowedCountryCodes: string[];
 }
@@ -4101,6 +4193,9 @@ interface InputFieldNonNullableFields$1 {
     contactMapping?: FormFieldContactInfoNonNullableFields$1;
     readOnly: boolean;
 }
+interface RichContentOptionsNonNullableFields$1 {
+    richContent?: RichContentNonNullableFields$1;
+}
 interface HeaderNonNullableFields$1 {
     content?: RichContentNonNullableFields$1;
 }
@@ -4108,8 +4203,10 @@ interface RichTextNonNullableFields$1 {
     content?: RichContentNonNullableFields$1;
 }
 interface DisplayFieldNonNullableFields$1 {
+    richContentOptions?: RichContentOptionsNonNullableFields$1;
     header?: HeaderNonNullableFields$1;
     richText?: RichTextNonNullableFields$1;
+    displayFieldType: DisplayFieldType$1;
 }
 interface ThankYouMessageNonNullableFields$1 {
     text?: RichContentNonNullableFields$1;
@@ -4289,6 +4386,17 @@ interface FormsSchemaProvidersConfigNonNullableFields$1 {
 interface ListFormsProvidersConfigsResponseNonNullableFields$1 {
     configs: FormsSchemaProvidersConfigNonNullableFields$1[];
 }
+interface FieldNonNullableFields$1 {
+    type: FieldInputType$1;
+    deleted: boolean;
+}
+interface FormSummaryNonNullableFields$1 {
+    id: string;
+    fields: FieldNonNullableFields$1[];
+}
+interface GetFormSummaryResponseNonNullableFields$1 {
+    formSummary?: FormSummaryNonNullableFields$1;
+}
 
 interface Form {
     /**
@@ -7020,14 +7128,6 @@ interface InputFieldMultilineAddressComponentTypeOptionsOneOf {
     /** Multiline address input field. */
     multilineAddressOptions?: MultilineAddress;
 }
-interface Header {
-    /** Content of the header */
-    content?: RichContent;
-}
-interface RichText {
-    /** Content of the rich text field */
-    content?: RichContent;
-}
 declare enum Target {
     /** Undefined target. */
     UNDEFINED = "UNDEFINED",
@@ -7118,11 +7218,25 @@ interface InputFieldInputTypeOptionsOneOf {
     /** Input returns multiline address as value. */
     multilineAddressOptions?: InputFieldMultilineAddress;
 }
-interface DisplayField extends DisplayFieldComponentTypeOneOf {
+/** Copy of the entity existing in form template project, needed to hide translations. */
+interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf, DisplayFieldComponentTypeOneOf {
+    /** Component displaying rich content */
+    richContentOptions?: RichContentOptions;
+    /** Page navigation component resolving as navigation or submit buttons */
+    pageNavigationOptions?: PageNavigationOptions;
     /** Header field */
     header?: Header;
     /** Rich text field */
     richText?: RichText;
+    /** Type of the display field */
+    displayFieldType?: DisplayFieldType;
+}
+/** @oneof */
+interface DisplayFieldDisplayFieldTypeOptionsOneOf {
+    /** Component displaying rich content */
+    richContentOptions?: RichContentOptions;
+    /** Page navigation component resolving as navigation or submit buttons */
+    pageNavigationOptions?: PageNavigationOptions;
 }
 /** @oneof */
 interface DisplayFieldComponentTypeOneOf {
@@ -7131,6 +7245,31 @@ interface DisplayFieldComponentTypeOneOf {
     /** Rich text field */
     richText?: RichText;
 }
+declare enum DisplayFieldType {
+    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
+    RICH_CONTENT = "RICH_CONTENT",
+    PAGE_NAVIGATION = "PAGE_NAVIGATION"
+}
+interface RichContentOptions {
+    /** Content of the header */
+    richContent?: RichContent;
+}
+interface PageNavigationOptions {
+    /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
+    nextPageText?: string | null;
+    /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
+    previousPageText?: string | null;
+    /** Text on the button when button is submitting a form */
+    submitText?: string | null;
+}
+interface Header {
+    /** Content of the header */
+    content?: RichContent;
+}
+interface RichText {
+    /** Content of the rich text field */
+    content?: RichContent;
+}
 interface SubmitButton extends SubmitButtonSubmitActionOneOf {
     /**
      * Submit action effect is to show message
@@ -7821,6 +7960,67 @@ interface FormProviderRestrictions {
     /** Maximum amount of deleted forms allowed per namespace. */
     maxDeletedFormsAmount?: number | null;
 }
+interface GetFormSummaryRequest {
+    /** Id of the form to retrieve. */
+    formId: string;
+}
+interface GetFormSummaryResponse {
+    /** The retrieved form field summary. */
+    formSummary?: FormSummary;
+}
+interface FormSummary {
+    /** Form ID. */
+    _id?: string;
+    /** Summarized form fields. */
+    fields?: Field[];
+}
+declare enum FieldInputType {
+    UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    RATING = "RATING",
+    BOOLEAN = "BOOLEAN",
+    ARRAY = "ARRAY",
+    OBJECT = "OBJECT",
+    WIX_FILE = "WIX_FILE",
+    SIGNATURE = "SIGNATURE",
+    PAYMENT = "PAYMENT",
+    MULTILINE_ADDRESS = "MULTILINE_ADDRESS",
+    DATE = "DATE",
+    TIME = "TIME",
+    DATE_TIME = "DATE_TIME",
+    EMAIL = "EMAIL",
+    URL = "URL",
+    UUID = "UUID",
+    PHONE = "PHONE",
+    URI = "URI",
+    HOSTNAME = "HOSTNAME",
+    COLOR_HEX = "COLOR_HEX",
+    CURRENCY = "CURRENCY",
+    LANGUAGE = "LANGUAGE",
+    DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
+}
+interface FieldOption {
+    /** Selectable option label */
+    label?: string | null;
+    /** Selectable option value, which is saved to DB. */
+    value?: string | null;
+}
+interface Field {
+    /** Definition of a target where the value of field belongs. */
+    target?: string | null;
+    /** Label of the field */
+    label?: string | null;
+    /** Input type of the field */
+    type?: FieldInputType;
+    /** List of options to select from */
+    options?: FieldOption[];
+    /**
+     * Flag indicating whether field is deleted.
+     * Default: false.
+     */
+    deleted?: boolean;
+}
 interface PhoneConstraintsNonNullableFields {
     allowedCountryCodes: string[];
 }
@@ -8364,6 +8564,9 @@ interface InputFieldNonNullableFields {
     contactMapping?: FormFieldContactInfoNonNullableFields;
     readOnly: boolean;
 }
+interface RichContentOptionsNonNullableFields {
+    richContent?: RichContentNonNullableFields;
+}
 interface HeaderNonNullableFields {
     content?: RichContentNonNullableFields;
 }
@@ -8371,8 +8574,10 @@ interface RichTextNonNullableFields {
     content?: RichContentNonNullableFields;
 }
 interface DisplayFieldNonNullableFields {
+    richContentOptions?: RichContentOptionsNonNullableFields;
     header?: HeaderNonNullableFields;
     richText?: RichTextNonNullableFields;
+    displayFieldType: DisplayFieldType;
 }
 interface ThankYouMessageNonNullableFields {
     text?: RichContentNonNullableFields;
@@ -8552,6 +8757,17 @@ interface FormsSchemaProvidersConfigNonNullableFields {
 interface ListFormsProvidersConfigsResponseNonNullableFields {
     configs: FormsSchemaProvidersConfigNonNullableFields[];
 }
+interface FieldNonNullableFields {
+    type: FieldInputType;
+    deleted: boolean;
+}
+interface FormSummaryNonNullableFields {
+    _id: string;
+    fields: FieldNonNullableFields[];
+}
+interface GetFormSummaryResponseNonNullableFields {
+    formSummary?: FormSummaryNonNullableFields;
+}
 
 type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -8597,6 +8813,9 @@ declare function updateExtendedFields$1(): __PublicMethodMetaInfo$2<'POST', {
     id: string;
 }, UpdateExtendedFieldsRequest$2, UpdateExtendedFieldsRequest$3, UpdateExtendedFieldsResponse$2 & UpdateExtendedFieldsResponseNonNullableFields$2, UpdateExtendedFieldsResponse$3 & UpdateExtendedFieldsResponseNonNullableFields$3>;
 declare function listFormsProvidersConfigs(): __PublicMethodMetaInfo$2<'GET', {}, ListFormsProvidersConfigsRequest, ListFormsProvidersConfigsRequest$1, ListFormsProvidersConfigsResponse & ListFormsProvidersConfigsResponseNonNullableFields, ListFormsProvidersConfigsResponse$1 & ListFormsProvidersConfigsResponseNonNullableFields$1>;
+declare function getFormSummary(): __PublicMethodMetaInfo$2<'GET', {
+    formId: string;
+}, GetFormSummaryRequest, GetFormSummaryRequest$1, GetFormSummaryResponse & GetFormSummaryResponseNonNullableFields, GetFormSummaryResponse$1 & GetFormSummaryResponseNonNullableFields$1>;
 
 declare const meta$2_bulkCreateForm: typeof bulkCreateForm;
 declare const meta$2_bulkRemoveDeletedField: typeof bulkRemoveDeletedField;
@@ -8606,6 +8825,7 @@ declare const meta$2_createForm: typeof createForm;
 declare const meta$2_deleteForm: typeof deleteForm;
 declare const meta$2_getDeletedForm: typeof getDeletedForm;
 declare const meta$2_getForm: typeof getForm;
+declare const meta$2_getFormSummary: typeof getFormSummary;
 declare const meta$2_listDeletedForms: typeof listDeletedForms;
 declare const meta$2_listForms: typeof listForms;
 declare const meta$2_listFormsProvidersConfigs: typeof listFormsProvidersConfigs;
@@ -8616,7 +8836,7 @@ declare const meta$2_removeFormFromTrashBin: typeof removeFormFromTrashBin;
 declare const meta$2_restoreFromTrashBin: typeof restoreFromTrashBin;
 declare const meta$2_updateForm: typeof updateForm;
 declare namespace meta$2 {
-  export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkCreateForm as bulkCreateForm, meta$2_bulkRemoveDeletedField as bulkRemoveDeletedField, meta$2_cloneForm as cloneForm, meta$2_countForms as countForms, meta$2_createForm as createForm, meta$2_deleteForm as deleteForm, meta$2_getDeletedForm as getDeletedForm, meta$2_getForm as getForm, meta$2_listDeletedForms as listDeletedForms, meta$2_listForms as listForms, meta$2_listFormsProvidersConfigs as listFormsProvidersConfigs, meta$2_listTemplateExtensions as listTemplateExtensions, meta$2_queryDeletedForms as queryDeletedForms, meta$2_queryForms as queryForms, meta$2_removeFormFromTrashBin as removeFormFromTrashBin, meta$2_restoreFromTrashBin as restoreFromTrashBin, updateExtendedFields$1 as updateExtendedFields, meta$2_updateForm as updateForm };
+  export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkCreateForm as bulkCreateForm, meta$2_bulkRemoveDeletedField as bulkRemoveDeletedField, meta$2_cloneForm as cloneForm, meta$2_countForms as countForms, meta$2_createForm as createForm, meta$2_deleteForm as deleteForm, meta$2_getDeletedForm as getDeletedForm, meta$2_getForm as getForm, meta$2_getFormSummary as getFormSummary, meta$2_listDeletedForms as listDeletedForms, meta$2_listForms as listForms, meta$2_listFormsProvidersConfigs as listFormsProvidersConfigs, meta$2_listTemplateExtensions as listTemplateExtensions, meta$2_queryDeletedForms as queryDeletedForms, meta$2_queryForms as queryForms, meta$2_removeFormFromTrashBin as removeFormFromTrashBin, meta$2_restoreFromTrashBin as restoreFromTrashBin, updateExtendedFields$1 as updateExtendedFields, meta$2_updateForm as updateForm };
 }
 
 /**