@wix/forms 1.0.52 → 1.0.54

package/build/cjs/src/forms-v4-submission.universal.d.ts

@@ -48,15 +48,12 @@ export interface FormSubmission {
      * @readonly
      */
     submitter?: Submitter;
-    /** Whether the submission was read by a site collaborator with permissions to manage submissions. */
+    /** Whether the submission was read by a site Extension with permissions to manage submissions. */
     seen?: boolean;
-    /**
-     * ID of the order related to submission (applicable if form has payments added).
-     * @readonly
-     */
-    orderId?: string | null;
     /** Data extensions ExtendedFields. */
     extendedFields?: ExtendedFields;
+    /** Order details. */
+    orderDetails?: OrderDetails;
 }
 export declare enum SubmissionStatus {
     UNDEFINED = "UNDEFINED",
@@ -113,9 +110,33 @@ export interface ExtendedFields {
      * The value of each key is structured according to the schema defined when the extended fields were configured.
      *
      * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+export interface OrderDetails {
+    /**
+     * ID of the order related to submission (applicable if form has payments added).
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Order number.
+     * @readonly
+     */
+    number?: string | null;
+    /**
+     * Currency.
+     * @readonly
+     */
+    currency?: string;
+    /**
+     * Item subtotal.
+     * @readonly
+     */
+    itemSubtotal?: string;
+}
 export interface CreateCheckoutFromSubmissionRequest extends CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
     /** Submission's form. */
     form?: Form;
@@ -205,8 +226,18 @@ export interface FormField {
     hidden?: boolean;
     /** Field view properties. */
     view?: Record<string, any> | null;
-}
-export interface StringType {
+    /** Details identifying field, which is extension of other entity */
+    dataExtensionsDetails?: DataExtensionsDetails;
+}
+export interface StringType extends StringTypeFormatOptionsOneOf {
+    /** DATE format options */
+    dateOptions?: DateTimeConstraints;
+    /** DATE_TIME format options */
+    dateTimeOptions?: DateTimeConstraints;
+    /** TIME format options */
+    timeOptions?: DateTimeConstraints;
+    /** DATE_OPTIONAL_TIME format options */
+    dateOptionalTimeOptions?: DateTimeConstraints;
     /** Minimum length. */
     minLength?: number | null;
     /** Maximum length. */
@@ -220,6 +251,17 @@ export interface StringType {
     /** List of allowed values. */
     enum?: string[] | null;
 }
+/** @oneof */
+export interface StringTypeFormatOptionsOneOf {
+    /** DATE format options */
+    dateOptions?: DateTimeConstraints;
+    /** DATE_TIME format options */
+    dateTimeOptions?: DateTimeConstraints;
+    /** TIME format options */
+    timeOptions?: DateTimeConstraints;
+    /** DATE_OPTIONAL_TIME format options */
+    dateOptionalTimeOptions?: DateTimeConstraints;
+}
 export declare enum Format {
     UNDEFINED = "UNDEFINED",
     DATE = "DATE",
@@ -233,12 +275,29 @@ export declare enum Format {
     HOSTNAME = "HOSTNAME",
     COLOR_HEX = "COLOR_HEX",
     CURRENCY = "CURRENCY",
-    LANGUAGE = "LANGUAGE"
+    LANGUAGE = "LANGUAGE",
+    DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
 }
 export interface StringErrorMessages {
     /** Default error message on invalid validation. */
     default?: string | null;
 }
+export interface DateTimeConstraints {
+    /**
+     * Support static constrains defined as ISO date/time format, as well as
+     * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
+     * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
+     * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
+     */
+    minimum?: string | null;
+    /**
+     * Support static constrains defined as ISO date/time format, as well as
+     * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
+     * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
+     * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
+     */
+    maximum?: string | null;
+}
 export interface NumberType {
     /** Inclusive maximum value. */
     maximum?: number | null;
@@ -353,17 +412,86 @@ export interface ArrayErrorMessages {
     /** Default error message on invalid validation. */
     default?: string | null;
 }
-export interface PredefinedValidation {
+export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
+    /** Payment input field. */
+    paymentOptions?: PaymentType;
     /** Format of predefined validation. */
     format?: ValidationFormat;
 }
+/** @oneof */
+export interface PredefinedValidationFormatOptionsOneOf {
+    /** Payment input field. */
+    paymentOptions?: PaymentType;
+}
 export declare enum ValidationFormat {
     UNDEFINED = "UNDEFINED",
     /** File upload validation. */
     WIX_FILE = "WIX_FILE",
-    /** Payment validation (described in payment trigger). */
+    /** Payment validation. */
     PAYMENT = "PAYMENT"
 }
+export interface PaymentType {
+    /** Field mapped to products. */
+    products?: Product[];
+    /** Minimum amount of different products. */
+    minItems?: number | null;
+    /** Maximum amount of different products. */
+    maxItems?: number | null;
+}
+export declare enum ProductType {
+    UNKNOWN = "UNKNOWN",
+    /** Shippable (physical). */
+    SHIPPABLE = "SHIPPABLE",
+    /** Digital. */
+    DIGITAL = "DIGITAL"
+}
+export declare enum PriceType {
+    UNKNOWN = "UNKNOWN",
+    /** Fixed price. */
+    FIXED_PRICE = "FIXED_PRICE",
+    /** Dynamic price from price range. */
+    DYNAMIC_PRICE = "DYNAMIC_PRICE"
+}
+export interface QuantityLimit {
+    /** Minimum quantity. */
+    minimum?: number | null;
+    /** Maximum quantity. */
+    maximum?: number | null;
+}
+export interface FixedPriceOptions {
+    /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
+    price?: string;
+}
+export interface DynamicPriceOptions {
+    /** Minimal price monetary amount. */
+    minPrice?: string;
+    /** Maximal price monetary amount. */
+    maxPrice?: string | null;
+}
+export interface Product extends ProductPriceOptionsOneOf {
+    /** Fixed price options. */
+    fixedPriceOptions?: FixedPriceOptions;
+    /** Dynamic price options. */
+    dynamicPriceOptions?: DynamicPriceOptions;
+    /**
+     * Product ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Product type. */
+    productType?: ProductType;
+    /** Price type. */
+    priceType?: PriceType;
+    /** Quantity limit. */
+    quantityLimit?: QuantityLimit;
+}
+/** @oneof */
+export interface ProductPriceOptionsOneOf {
+    /** Fixed price options. */
+    fixedPriceOptions?: FixedPriceOptions;
+    /** Dynamic price options. */
+    dynamicPriceOptions?: DynamicPriceOptions;
+}
 export interface NestedFormFieldOverrides {
     /** Whether the field is required. Leave blank for no override. */
     required?: boolean | null;
@@ -405,6 +533,10 @@ export interface ValidationValidationOneOf {
     /** Predefined validation of specific format */
     predefined?: PredefinedValidation;
 }
+export interface DataExtensionsDetails {
+    /** FQDNS which can be extended with this field */
+    fqdns?: string[];
+}
 export interface NestedFormOverrides {
     /** Field overrides by field ID */
     fieldOverrides?: Record<string, NestedFormFieldOverrides>;
@@ -1687,7 +1819,8 @@ export declare enum FormatEnumFormat {
     HOSTNAME = "HOSTNAME",
     COLOR_HEX = "COLOR_HEX",
     CURRENCY = "CURRENCY",
-    LANGUAGE = "LANGUAGE"
+    LANGUAGE = "LANGUAGE",
+    DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
 }
 export interface InputFieldStringErrorMessages {
     /** Default error message on invalid validation. */
@@ -1995,7 +2128,7 @@ export interface FileUpload {
 export interface CheckboxGroupOption {
     /** Selectable option label. */
     label?: string | null;
-    /** Selectable option value, which is saved to DB. Corresponds to product id, found in payment trigger field's products list. */
+    /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
     value?: any;
     /** Option id. Used as binding for translations. */
     _id?: string;
@@ -2127,6 +2260,8 @@ export interface Payment extends PaymentComponentTypeOptionsOneOf {
      * @readonly
      */
     componentType?: PaymentComponentType;
+    /** Validation of payment type. */
+    validation?: PaymentType;
 }
 /** @oneof */
 export interface PaymentComponentTypeOptionsOneOf {
@@ -2280,6 +2415,8 @@ export interface BreakPoint {
     margin?: Margin;
     /** Description of elements paddings. */
     padding?: Margin;
+    /** Sections of the layout, which allow manage fields */
+    sections?: Section[];
 }
 export interface ItemLayout {
     /** Form field reference id. */
@@ -2299,6 +2436,20 @@ export interface Margin {
     /** Vertical value. */
     vertical?: number | null;
 }
+export interface Section {
+    /** Id of the section */
+    _id?: string;
+    /** Horizontal coordinate in the grid. */
+    row?: number | null;
+    /**
+     * A list of field identifiers that are permitted to be placed within a section.
+     * The section will only accept fields with IDs specified in this list.
+     * If the section encounters the $new key within the list,
+     * it allows the inclusion of fields not explicitly listed,
+     * enabling dynamic addition of new fields.
+     */
+    allowedFieldIds?: string[];
+}
 export interface FormRule {
     /** Id of the rule */
     _id?: string;
@@ -2339,8 +2490,6 @@ export declare enum Kind {
 export interface PostSubmissionTriggers {
     /** Upserts a contact from the submission data. */
     upsertContact?: UpsertContact;
-    /** Payment trigger. */
-    paymentTrigger?: PaymentTrigger;
 }
 export interface UpsertContact {
     /** Fields mapping (target field mapped to corresponding contact field). */
@@ -2417,72 +2566,6 @@ export interface CustomFieldInfo {
     /** Custom field key. */
     key?: string;
 }
-export interface PaymentTrigger {
-    /** Fields mapping (target field mapped to corresponding payment field). */
-    fieldsMapping?: Record<string, FormFieldPaymentInfo>;
-}
-export interface FormFieldPaymentInfo {
-    /** Field mapped to products. */
-    products?: Product[];
-    /** Minimum amount of different products. */
-    minItems?: number | null;
-    /** Maximum amount of different products. */
-    maxItems?: number | null;
-}
-export declare enum ProductType {
-    UNKNOWN = "UNKNOWN",
-    /** Shippable (physical). */
-    SHIPPABLE = "SHIPPABLE",
-    /** Digital. */
-    DIGITAL = "DIGITAL"
-}
-export declare enum PriceType {
-    UNKNOWN = "UNKNOWN",
-    /** Fixed price. */
-    FIXED_PRICE = "FIXED_PRICE",
-    /** Dynamic price from price range. */
-    DYNAMIC_PRICE = "DYNAMIC_PRICE"
-}
-export interface QuantityLimit {
-    /** Minimum quantity. */
-    minimum?: number | null;
-    /** Maximum quantity. */
-    maximum?: number | null;
-}
-export interface FixedPriceOptions {
-    /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
-    price?: string;
-}
-export interface DynamicPriceOptions {
-    /** Minimal price monetary amount. */
-    minPrice?: string;
-    /** Maximal price monetary amount. */
-    maxPrice?: string | null;
-}
-export interface Product extends ProductPriceOptionsOneOf {
-    /** Fixed price options. */
-    fixedPriceOptions?: FixedPriceOptions;
-    /** Dynamic price options. */
-    dynamicPriceOptions?: DynamicPriceOptions;
-    /**
-     * Product ID.
-     * @readonly
-     */
-    _id?: string;
-    /** Product type. */
-    productType?: ProductType;
-    /** Price type. */
-    priceType?: PriceType;
-    /** Quantity limit. */
-    quantityLimit?: QuantityLimit;
-}
-/** @oneof */
-export interface ProductPriceOptionsOneOf {
-    /** Fixed price options. */
-    fixedPriceOptions?: FixedPriceOptions;
-    /** Dynamic price options. */
-    dynamicPriceOptions?: DynamicPriceOptions;
-}
 export interface NestedForm {
     /** Targets which have this form. */
     targets?: string[];
@@ -2493,6 +2576,10 @@ export interface CreateCheckoutFromSubmissionResponse {
     /** Checkout ID (applicable for form involving payments). */
     checkoutId?: string | null;
 }
+export interface IsFormSubmittableRequest {
+}
+export interface IsFormSubmittableResponse {
+}
 export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -2554,6 +2641,8 @@ export interface EntityUpdatedEvent {
     currentEntityAsJson?: string;
 }
 export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
 }
 export interface ActionEvent {
     bodyAsJson?: string;
@@ -2635,8 +2724,6 @@ export interface CreateSubmissionResponse {
 export interface CreateSubmissionBySubmitterRequest {
     /** Submission to create. */
     submission?: FormSubmission;
-    /** When set, and when spam validation is enabled by the namespace provider, will validate a submission for spam. */
-    validateSpam?: boolean;
 }
 export interface CreateSubmissionBySubmitterResponse {
     /** The created submission. */
@@ -2651,8 +2738,6 @@ export interface BulkCreateSubmissionBySubmitterRequest {
     submissions?: FormSubmission[];
     /** When set, items will be returned on successful create. */
     returnEntity?: boolean;
-    /** When set, and when spam validation is enabled by the namespace provider, will validate a submission for spam. */
-    validateSpam?: boolean;
 }
 export interface BulkCreateSubmissionBySubmitterResponse {
     /** Created submissions with metadata */
@@ -2918,7 +3003,7 @@ export interface FormSubmissionsCount {
     formId?: string;
     /** Total number of submissions. */
     totalCount?: number;
-    /** Number of submissions that haven't yet been seen by site collaborators with manage submission permissions. */
+    /** Number of submissions that haven't yet been seen by site Extensions with manage submission permissions. */
     unseenCount?: number;
 }
 export interface CountDeletedSubmissionsRequest {
@@ -3001,6 +3086,11 @@ export interface CreateSubmissionResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface GetSubmissionResponseNonNullableFields {
@@ -3009,6 +3099,11 @@ export interface GetSubmissionResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface UpdateSubmissionResponseNonNullableFields {
@@ -3017,6 +3112,11 @@ export interface UpdateSubmissionResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface ConfirmSubmissionResponseNonNullableFields {
@@ -3025,6 +3125,11 @@ export interface ConfirmSubmissionResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface BulkDeleteSubmissionResponseNonNullableFields {
@@ -3050,6 +3155,11 @@ export interface RestoreSubmissionFromTrashBinResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface BulkRemoveSubmissionFromTrashBinResponseNonNullableFields {
@@ -3075,6 +3185,11 @@ export interface ListDeletedSubmissionsResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     }[];
 }
 export interface GetDeletedSubmissionResponseNonNullableFields {
@@ -3083,6 +3198,11 @@ export interface GetDeletedSubmissionResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     };
 }
 export interface QuerySubmissionsByNamespaceResponseNonNullableFields {
@@ -3091,6 +3211,11 @@ export interface QuerySubmissionsByNamespaceResponseNonNullableFields {
         namespace: string;
         status: SubmissionStatus;
         seen: boolean;
+        orderDetails?: {
+            _id: string;
+            currency: string;
+            itemSubtotal: string;
+        };
     }[];
 }
 export interface CountSubmissionsResponseNonNullableFields {
@@ -3110,7 +3235,10 @@ export interface GetMediaUploadURLResponseNonNullableFields {
     uploadUrl: string;
 }
 /**
- * Creates a new submission.
+ * > **Note**:
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
+ * Creates a submission.
  * @param submission - Submission to create.
  * @public
  * @documentationMaturity preview
@@ -3127,6 +3255,9 @@ export interface CreateSubmissionOptions {
     captchaToken?: string | null;
 }
 /**
+ * > **Note:**
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
  * Retrieves a submission by ID.
  * @param submissionId - ID of the submission to retrieve.
  * @public
@@ -3141,8 +3272,12 @@ export interface CreateSubmissionOptions {
  */
 export declare function getSubmission(submissionId: string): Promise<FormSubmission & NonNullable<GetSubmissionResponseNonNullableFields>['submission']>;
 /**
+ * > **Note**:
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
  * Updates a submission.
  *
+ *
  * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
  * @param _id - Submission ID.
  * @public
@@ -3200,21 +3335,23 @@ export interface UpdateSubmission {
      * @readonly
      */
     submitter?: Submitter;
-    /** Whether the submission was read by a site collaborator with permissions to manage submissions. */
+    /** Whether the submission was read by a site Extension with permissions to manage submissions. */
     seen?: boolean;
-    /**
-     * ID of the order related to submission (applicable if form has payments added).
-     * @readonly
-     */
-    orderId?: string | null;
     /** Data extensions ExtendedFields. */
     extendedFields?: ExtendedFields;
+    /** Order details. */
+    orderDetails?: OrderDetails;
 }
 /**
+ * > **Note**:
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
  * Confirms a submission.
  *
  *
- * You can only confirm a submission that has a `PENDING` status. The default status when a submission is created is `CONFIRMED`. You can change the default status for individual submissions using the `createSubmission()` or `updateSubmission()` methods.
+ * You can only confirm a submission that has a `PENDING` status.
+ * When using forms from the [Wix Pricing Plans](https://www.wix.com/app-market/paid-plans?referral=collection&appIndex=42&referralTag=made-by-wix&referralSectionName=made-by-wix) app, the default submission status is `PENDING`.
+ * When using forms from the [Wix Forms]() app, the default form submission status is `CONFIRMED`. You can change the default status for individual submissions using the `updateSubmission()` method.
  * @param submissionId - Submission ID to confirm.
  * @public
  * @documentationMaturity preview
@@ -3224,7 +3361,10 @@ export interface UpdateSubmission {
  */
 export declare function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse & ConfirmSubmissionResponseNonNullableFields>;
 /**
- * Deletes a submission by ID.
+ * > **Note:**
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
+ * Deletes a submission.
  * @param submissionId - ID of the submission to delete.
  * @public
  * @documentationMaturity preview
@@ -3331,6 +3471,9 @@ export interface ListDeletedSubmissionsOptions {
  */
 export declare function getDeletedSubmission(submissionId: string): Promise<GetDeletedSubmissionResponse & GetDeletedSubmissionResponseNonNullableFields>;
 /**
+ * > **Note:**
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
  * Creates a query to retrieve a list of submissions.
  *
  * The `querySubmissionsByNamespace()` method builds a query to retrieve a list of submissions from the specified namespace and returns a [`SubmissionsQueryBuilder`](#submissionsquerybuilder) object.
@@ -3421,6 +3564,9 @@ export interface SubmissionsQueryBuilder {
     find: () => Promise<SubmissionsQueryResult>;
 }
 /**
+ * > **Note**:
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
  * Counts the number of submissions belonging to the specified forms.
  * @param formIds - Form IDs.
  * @param namespace - Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
@@ -3443,7 +3589,10 @@ export interface CountSubmissionsOptions {
     statuses?: SubmissionStatus[];
 }
 /**
- * Counts the number of deleted submissions belonging to the specified forms.
+ * > **Note:**
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
+ * Counts the number of submissions belonging to the specified forms.
  * @param formIds - Form IDs.
  * @param namespace - Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
  * @public
@@ -3465,7 +3614,10 @@ export interface CountDeletedSubmissionsOptions {
     statuses?: SubmissionStatus[];
 }
 /**
- * Retrieves a URL, generated by Media Manager, to use when creating a submission with a field for uploading files.
+ * > **Note:**
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
+ * Retrieves a URL generated by Media Manager to use when creating a submission that includes a field for uploading files.
  *
  * @param formId - Form ID.
  * @param filename - Name of file to upload.
@@ -3484,7 +3636,11 @@ export interface CountDeletedSubmissionsOptions {
  */
 export declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<GetMediaUploadURLResponse & GetMediaUploadURLResponseNonNullableFields>;
 /**
- * Marks form submissions as seen by site collaborators with manage submission permissions.
+ * > **Note**:
+ * > The Submissions API is only available in the Wix Studio editor.
+ *
+ * Marks form submissions as **seen**.
+ * Only site collaborators with **Manage Submission** permissions can mark submissions.
  * @param ids - Submission IDs to mark as seen.
  * @param formId - ID of the form which the submissions belongs to.
  * @public