@wix/auto_sdk_forms_forms 1.0.22 → 1.0.24

package/build/es/src/forms-v4-form-forms.universal.d.ts

@@ -94,24 +94,6 @@ export interface Form {
      */
     formRules?: Rule[];
 }
-export declare enum RequiredIndicator {
-    /** Unknown required indicator. */
-    UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
-    /** Asterisk (*). */
-    ASTERISK = "ASTERISK",
-    /** Text (default: "Required"). */
-    TEXT = "TEXT",
-    /** None. */
-    NONE = "NONE"
-}
-export declare enum RequiredIndicatorPlacement {
-    /** Unknown required indicator placement. */
-    UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
-    /** After field title. */
-    AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
-    /** Before field title. */
-    BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
-}
 export interface FormField {
     /**
      * Item ID.
@@ -934,17 +916,32 @@ export interface ButtonData {
     link?: Link;
 }
 export interface Border {
-    /** Border width in pixels. */
+    /**
+     * Deprecated: Use `borderWidth` in `styles` instead.
+     * @deprecated
+     */
     width?: number | null;
-    /** Border radius in pixels. */
+    /**
+     * Deprecated: Use `borderRadius` in `styles` instead.
+     * @deprecated
+     */
     radius?: number | null;
 }
 export interface Colors {
-    /** The text color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `textColor` in `styles` instead.
+     * @deprecated
+     */
     text?: string | null;
-    /** The border color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `borderColor` in `styles` instead.
+     * @deprecated
+     */
     border?: string | null;
-    /** The background color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `backgroundColor` in `styles` instead.
+     * @deprecated
+     */
     background?: string | null;
 }
 export interface PluginContainerData {
@@ -1021,10 +1018,57 @@ export declare enum ButtonDataType {
     ACTION = "ACTION"
 }
 export interface Styles {
-    /** Border attributes. */
+    /**
+     * Deprecated: Use `borderWidth` and `borderRadius` instead.
+     * @deprecated
+     */
     border?: Border;
-    /** Color attributes. */
+    /**
+     * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
+     * @deprecated
+     */
     colors?: Colors;
+    /** Border width in pixels. */
+    borderWidth?: number | null;
+    /**
+     * Deprecated: Use `borderWidth` for normal/hover states instead.
+     * @deprecated
+     */
+    borderWidthHover?: number | null;
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /**
+     * Border color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    borderColorHover?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Text color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    textColorHover?: string | null;
+    /**
+     * Background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Background color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    backgroundColorHover?: string | null;
+    /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
+    buttonSize?: string | null;
 }
 export interface Link extends LinkDataOneOf {
     /** The absolute URL for the linked document. */
@@ -4397,6 +4441,24 @@ export interface RequiredIndicatorProperties {
     /** Required indicator placement. */
     requiredIndicatorPlacement?: RequiredIndicatorPlacement;
 }
+export declare enum RequiredIndicator {
+    /** Unknown required indicator. */
+    UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
+    /** Asterisk (*). */
+    ASTERISK = "ASTERISK",
+    /** Text (default: "Required"). */
+    TEXT = "TEXT",
+    /** None. */
+    NONE = "NONE"
+}
+export declare enum RequiredIndicatorPlacement {
+    /** Unknown required indicator placement. */
+    UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
+    /** After field title. */
+    AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
+    /** Before field title. */
+    BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
+}
 export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {
     /** Options for showing a thank you message after submission. */
     thankYouMessageOptions?: ThankYouMessageOptions;
@@ -4575,11 +4637,8 @@ export interface Condition {
     target?: string;
     /** The operator to use for comparison. */
     operator?: Operator;
-    /**
-     * The value to compare against.
-     * @maxLength 500
-     */
-    value?: string;
+    /** The value to compare against. */
+    value?: any;
 }
 export declare enum Operator {
     UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
@@ -5134,7 +5193,7 @@ export interface CountFormsRequest {
      * @minLength 10
      * @maxLength 50
      */
-    namespace: string;
+    namespace?: string;
     /**
      * Fieldsets.
      * @maxSize 3
@@ -5156,6 +5215,36 @@ export interface CountFormsResponse {
     /** Deleted forms count. Counted only if specifically requested using a fieldset. */
     deletedCount?: number | null;
 }
+export interface CountFormsByFilterRequest {
+    /** Filter */
+    filter?: Record<string, any> | null;
+    /**
+     * Namespace
+     * @minLength 10
+     * @maxLength 50
+     * @immutable
+     */
+    namespace: string;
+}
+export interface CountFormsByFilterResponse {
+    /** Total forms count. Includes active and disabled forms. Does not include deleted forms. */
+    count?: number;
+}
+export interface CountDeletedFormsRequest {
+    /** Filter */
+    filter?: Record<string, any> | null;
+    /**
+     * Namespace
+     * @minLength 10
+     * @maxLength 50
+     * @immutable
+     */
+    namespace: string;
+}
+export interface CountDeletedFormsResponse {
+    /** Deleted forms count. */
+    count?: number;
+}
 export interface ListTemplateExtensionsRequest {
     /**
      * Namespace name.
@@ -5561,6 +5650,14 @@ export interface FormSummaryField {
      */
     _id?: string;
 }
+export interface CreateMigratedFormRequest {
+    /** Form to be created. */
+    form?: Form;
+}
+export interface CreateMigratedFormResponse {
+    /** The created form. */
+    form?: Form;
+}
 interface StringTypePhoneConstraintsNonNullableFields {
     allowedCountryCodes: string[];
 }
@@ -6326,7 +6423,6 @@ interface OrConditionNonNullableFields {
 interface ConditionNonNullableFields {
     target: string;
     operator: Operator;
-    value: string;
 }
 interface ConditionNodeNonNullableFields {
     and?: AndConditionNonNullableFields;
@@ -6418,10 +6514,11 @@ export interface RestoreFromTrashBinResponseNonNullableFields {
 export interface QueryFormsResponseNonNullableFields {
     forms: FormNonNullableFields[];
 }
-export interface CountFormsResponseNonNullableFields {
-    totalCount: number;
-    activeCount: number;
-    disabledCount: number;
+export interface CountFormsByFilterResponseNonNullableFields {
+    count: number;
+}
+export interface CountDeletedFormsResponseNonNullableFields {
+    count: number;
 }
 export interface ListFormsResponseNonNullableFields {
     forms: FormNonNullableFields[];
@@ -6475,6 +6572,9 @@ export interface GetFormSummaryResponseNonNullableFields {
  * @requiredField form.rules._id
  * @requiredField form.steps._id
  * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @returns The created form.
  * @fqn wix.forms.v4.FormSchemaService.CreateForm
  */
@@ -6487,6 +6587,9 @@ export declare function createForm(form: Form): Promise<Form & FormNonNullableFi
  * @requiredField options.forms.rules._id
  * @requiredField options.forms.steps._id
  * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.BulkCreateForm
  */
 export declare function bulkCreateForm(options?: BulkCreateFormOptions): Promise<BulkCreateFormResponse & BulkCreateFormResponseNonNullableFields>;
@@ -6507,6 +6610,9 @@ export interface BulkCreateFormOptions {
  * @documentationMaturity preview
  * @requiredField formId
  * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.CloneForm
  */
 export declare function cloneForm(formId: string): Promise<CloneFormResponse & CloneFormResponseNonNullableFields>;
@@ -6521,6 +6627,8 @@ export declare function cloneForm(formId: string): Promise<CloneFormResponse & C
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
@@ -6545,6 +6653,9 @@ export interface GetFormOptions {
  * @requiredField form.rules._id
  * @requiredField form.steps._id
  * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @returns The updated form.
  * @fqn wix.forms.v4.FormSchemaService.UpdateForm
  */
@@ -6653,6 +6764,9 @@ export interface UpdateForm {
  * @documentationMaturity preview
  * @requiredField formId
  * @permissionId WIX_FORMS.FORM_SCHEMA_DELETE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.RemoveFormFromTrashBin
  */
 export declare function removeFormFromTrashBin(formId: string): Promise<void>;
@@ -6664,6 +6778,9 @@ export declare function removeFormFromTrashBin(formId: string): Promise<void>;
  * @documentationMaturity preview
  * @requiredField formId
  * @permissionId WIX_FORMS.FORM_SCHEMA_DELETE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.DeleteForm
  */
 export declare function deleteForm(formId: string, options?: DeleteFormOptions): Promise<void>;
@@ -6681,6 +6798,9 @@ export interface DeleteFormOptions {
  * @documentationMaturity preview
  * @requiredField formId
  * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.RestoreFromTrashBin
  */
 export declare function restoreFromTrashBin(formId: string): Promise<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
@@ -6692,6 +6812,8 @@ export declare function restoreFromTrashBin(formId: string): Promise<RestoreFrom
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
@@ -6776,28 +6898,63 @@ export interface FormsQueryBuilder {
 }
 /**
  * Counts forms.
- * @param namespace - Namespace name.
  * @public
  * @documentationMaturity preview
- * @requiredField namespace
+ * @requiredField options.namespace
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
  * @permissionScope Manage Submissions
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @fqn wix.forms.v4.FormSchemaService.CountForms
+ * @fqn wix.forms.v4.FormSchemaService.CountFormsByFilter
  */
-export declare function countForms(namespace: string, options?: CountFormsOptions): Promise<CountFormsResponse & CountFormsResponseNonNullableFields>;
-export interface CountFormsOptions {
+export declare function countFormsByFilter(options?: CountFormsByFilterOptions): Promise<CountFormsByFilterResponse & CountFormsByFilterResponseNonNullableFields>;
+export interface CountFormsByFilterOptions {
+    /** Filter */
+    filter?: Record<string, any> | null;
     /**
-     * Fieldsets.
-     * @maxSize 3
+     * Namespace
+     * @minLength 10
+     * @maxLength 50
+     * @immutable
      */
-    fieldsets?: CountFormsFieldset[];
+    namespace: string;
+}
+/**
+ * Counts deleted forms.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.namespace
+ * @permissionId WIX_FORMS.FORM_SCHEMA_READ
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage form submissions.
+ * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.forms.v4.FormSchemaService.CountDeletedForms
+ */
+export declare function countDeletedForms(options?: CountDeletedFormsOptions): Promise<CountDeletedFormsResponse & CountDeletedFormsResponseNonNullableFields>;
+export interface CountDeletedFormsOptions {
+    /** Filter */
+    filter?: Record<string, any> | null;
+    /**
+     * Namespace
+     * @minLength 10
+     * @maxLength 50
+     * @immutable
+     */
+    namespace: string;
 }
 /**
  * Lists forms, filtered by namespace and its disabled status. If specified, sorts forms in the desired order.
@@ -6811,6 +6968,8 @@ export interface CountFormsOptions {
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
@@ -6877,6 +7036,8 @@ export interface ListFormsOptions {
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
@@ -6895,6 +7056,8 @@ export declare function getDeletedForm(formId: string): Promise<GetDeletedFormRe
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
@@ -6913,6 +7076,8 @@ export declare function queryDeletedForms(query: CursorQuery): Promise<QueryDele
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
@@ -6974,6 +7139,9 @@ export interface BulkRemoveDeletedFieldOptions {
  * @requiredField options
  * @requiredField options.namespaceData
  * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.UpdateExtendedFields
  */
 export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
@@ -6986,6 +7154,9 @@ export interface UpdateExtendedFieldsOptions {
  * @public
  * @documentationMaturity preview
  * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.forms.v4.FormSchemaService.ListFormsProvidersConfigs
  */
 export declare function listFormsProvidersConfigs(): Promise<ListFormsProvidersConfigsResponse & ListFormsProvidersConfigsResponseNonNullableFields>;
@@ -7000,6 +7171,8 @@ export declare function listFormsProvidersConfigs(): Promise<ListFormsProvidersC
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
  * @permissionScope Manage form submissions.
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Set Up Automations
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP