@wix/auto_sdk_forms_submissions 1.0.148 → 1.0.149

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { hC as UpsertContactFromSubmissionRequest$1, a as UpsertContactFromSubmissionResponse$1, hE as CreateSubmissionRequest$1, hF as CreateSubmissionResponse$1, hR as GetSubmissionRequest$1, hS as GetSubmissionResponse$1, hV as UpdateSubmissionRequest$1, hW as UpdateSubmissionResponse$1, hX as ConfirmSubmissionRequest$1, f as ConfirmSubmissionResponse$1, hY as DeleteSubmissionRequest$1, hZ as DeleteSubmissionResponse$1, h_ as BulkDeleteSubmissionRequest$1, g as BulkDeleteSubmissionResponse$1, i0 as RestoreSubmissionFromTrashBinRequest$1, R as RestoreSubmissionFromTrashBinResponse$1, i1 as RemoveSubmissionFromTrashBinRequest$1, i2 as RemoveSubmissionFromTrashBinResponse$1, i3 as BulkRemoveSubmissionFromTrashBinRequest$1, i as BulkRemoveSubmissionFromTrashBinResponse$1, i5 as ListDeletedSubmissionsRequest$1, j as ListDeletedSubmissionsResponse$1, i6 as GetDeletedSubmissionRequest$1, G as GetDeletedSubmissionResponse$1, i7 as QuerySubmissionRequest$1, l as QuerySubmissionResponse$1, i8 as SearchSubmissionsByNamespaceRequest$1, S as SearchSubmissionsByNamespaceResponse$1, ib as QuerySubmissionsByNamespaceRequest$1, ic as QuerySubmissionsByNamespaceResponse$1, ig as CountSubmissionsByFilterRequest$1, o as CountSubmissionsByFilterResponse$1, ii as CountSubmissionsRequest$1, q as CountSubmissionsResponse$1, ij as CountDeletedSubmissionsRequest$1, s as CountDeletedSubmissionsResponse$1, il as GetMediaUploadURLRequest$1, t as GetMediaUploadURLResponse$1, im as BulkMarkSubmissionsAsSeenRequest$1, u as BulkMarkSubmissionsAsSeenResponse$1, io as GetSubmissionDownloadUrlRequest$1, v as GetSubmissionDownloadUrlResponse$1, is as DownloadSubmissionRequest$1, w as RawHttpResponse$1, iu as GetFormattedSubmissionRequest$1, x as GetFormattedSubmissionResponse$1, iz as UpdateExtendedFieldsRequest$1, z as UpdateExtendedFieldsResponse$1, iA as BulkUpdateFormSubmissionTagsRequest$1, iB as BulkUpdateFormSubmissionTagsResponse$1, iD as BulkUpdateFormSubmissionTagsByFilterRequest$1, iE as BulkUpdateFormSubmissionTagsByFilterResponse$1, iF as ValidateFormSubmissionRequest$1, A as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-DpxoO7nJ.js';
+import { hC as UpsertContactFromSubmissionRequest$1, a as UpsertContactFromSubmissionResponse$1, hE as CreateSubmissionRequest$1, hF as CreateSubmissionResponse$1, hR as GetSubmissionRequest$1, hS as GetSubmissionResponse$1, hV as UpdateSubmissionRequest$1, hW as UpdateSubmissionResponse$1, hX as ConfirmSubmissionRequest$1, f as ConfirmSubmissionResponse$1, hY as DeleteSubmissionRequest$1, hZ as DeleteSubmissionResponse$1, h_ as BulkDeleteSubmissionRequest$1, g as BulkDeleteSubmissionResponse$1, i0 as RestoreSubmissionFromTrashBinRequest$1, R as RestoreSubmissionFromTrashBinResponse$1, i1 as RemoveSubmissionFromTrashBinRequest$1, i2 as RemoveSubmissionFromTrashBinResponse$1, i3 as BulkRemoveSubmissionFromTrashBinRequest$1, i as BulkRemoveSubmissionFromTrashBinResponse$1, i5 as ListDeletedSubmissionsRequest$1, j as ListDeletedSubmissionsResponse$1, i6 as GetDeletedSubmissionRequest$1, G as GetDeletedSubmissionResponse$1, i7 as QuerySubmissionRequest$1, l as QuerySubmissionResponse$1, i8 as SearchSubmissionsByNamespaceRequest$1, S as SearchSubmissionsByNamespaceResponse$1, ib as QuerySubmissionsByNamespaceRequest$1, ic as QuerySubmissionsByNamespaceResponse$1, ig as CountSubmissionsByFilterRequest$1, o as CountSubmissionsByFilterResponse$1, ii as CountSubmissionsRequest$1, q as CountSubmissionsResponse$1, ij as CountDeletedSubmissionsRequest$1, s as CountDeletedSubmissionsResponse$1, il as GetMediaUploadURLRequest$1, t as GetMediaUploadURLResponse$1, im as BulkMarkSubmissionsAsSeenRequest$1, u as BulkMarkSubmissionsAsSeenResponse$1, io as GetSubmissionDownloadUrlRequest$1, v as GetSubmissionDownloadUrlResponse$1, is as DownloadSubmissionRequest$1, w as RawHttpResponse$1, iu as GetFormattedSubmissionRequest$1, x as GetFormattedSubmissionResponse$1, iz as UpdateExtendedFieldsRequest$1, z as UpdateExtendedFieldsResponse$1, iA as BulkUpdateFormSubmissionTagsRequest$1, iB as BulkUpdateFormSubmissionTagsResponse$1, iD as BulkUpdateFormSubmissionTagsByFilterRequest$1, iE as BulkUpdateFormSubmissionTagsByFilterResponse$1, iF as ValidateFormSubmissionRequest$1, A as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-Bfo2P_8S.js';
 import '@wix/sdk-types';
 
 /** Form submission that was created or retrieved. */
@@ -22,9 +22,27 @@ interface FormSubmission {
      * @readonly
      */
     namespace?: string;
-    /** Status of the submission. */
+    /**
+     * Status of the submission.
+     *
+     * The status a submission is created with depends on the form's namespace and on whether the form collects payment, so read it from the response rather than assuming.
+     *
+     * A submission for a form that collects payment starts as `PAYMENT_WAITING`. Otherwise, most namespaces record the submission immediately as `CONFIRMED`. Namespaces that need to complete another step first, such as taking payment for a pricing plan, create the submission as `PENDING` and confirm it later with Confirm Submission.
+     *
+     * A `PENDING` submission isn't recorded yet, and is deleted automatically if it isn't confirmed in time.
+     */
     status?: SubmissionStatusWithLiterals;
-    /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
+    /**
+     * Values the visitor submitted.
+     *
+     * Each key is the `target` of a field in the form schema, which is the field's stable storage key rather than its ID or label. Only keys matching a field target are accepted.
+     *
+     * Each value's shape follows that field's `inputType`: `STRING` fields submit a string, `NUMBER` a number, `BOOLEAN` a boolean, and `ARRAY` an array of the selected option values. Date and time fields are strings.
+     *
+     * 3 input types submit structured values: `ADDRESS` submits an address object, `PAYMENT` an array holding 1 product object per item bought, and `SCHEDULING` an appointment object.
+     *
+     * For the full mapping, see [Submission values](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/introduction#submission-values).
+     */
     submissions?: Record<string, any>;
     /**
      * Date and time the form submission was created.
@@ -645,12 +663,20 @@ interface Form {
     id?: string | null;
     /**
      * Form fields that define the input elements and their validation rules.
+     *
+     * The order of this array isn't the order the fields are displayed in. Display order comes from `steps`, where each layout item positions a field by `row` and `column`. Don't render fields in array order.
+     *
+     * For a detailed explanation of how to compose each kind of field, including which `identifier`, `inputType`, and `componentType` values to combine, see [About Form Fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields).
      * @maxSize 500
      */
     formFields?: Field[];
     /**
      * Layout configuration that defines how form fields are organized across multiple steps.
      * Each step represents a page of the form.
+     *
+     * Every field in `form_fields`, including the submit button, must be placed by a layout item whose `field_id` matches the field's `id`. A field that isn't placed still stores submitted values, but the Wix dashboard renders it, and the submissions made against it, as empty.
+     *
+     * Use a single step unless the form is split across pages.
      * @maxSize 100
      */
     steps?: Step[];
@@ -739,6 +765,8 @@ interface Form {
     enabled?: boolean | null;
     /**
      * Display name of the form schema.
+     *
+     * Names are unique in a namespace. If the name you pass is already taken, the request still succeeds, and the form schema is stored under a numbered variation of that name instead of returning an error. Read `name` from the response to learn the name the schema was actually saved under.
      * @maxLength 200
      */
     name?: string | null;
@@ -1345,6 +1373,8 @@ interface Field extends FieldFieldTypeOptionsOneOf {
     displayOptions?: DisplayField;
     /**
      * Field ID.
+     *
+     * The ID is stored in lowercase. Because the form's layout references each field by this ID, pass a lowercase GUID so that `id` and the layout's `field_id` still match after the form schema is stored. IDs must be unique in the form.
      * @format GUID
      * @immutable
      */
@@ -1356,11 +1386,24 @@ interface Field extends FieldFieldTypeOptionsOneOf {
      */
     hidden?: boolean;
     /**
-     * Custom identification for the field. This is intended as a way for you to identify certain fields that you want to apply special behavior to in your own logic.
+     * Identification for the field, describing its purpose. For example, `TEXT_INPUT` or `CONTACTS_EMAIL`.
+     *
+     * Set this to the known value for the kind of field you're creating.
+     * An unrecognized value, such as a custom string or a GUID, is dropped rather than rejected: the request still succeeds, but the field doesn't appear in the response's `form_fields`, and neither the field nor its submitted values appear in the Wix dashboard.
+     *
+     * Several fields share a general-purpose `componentType`, so `identifier` is often the only value that distinguishes them.
+     * For example, both a short answer field and a long answer field use the `TEXT_INPUT` component, and are told apart by their `TEXT_INPUT` and `TEXT_AREA` identifiers.
+     *
+     * For the full list of known values, see [About Form Fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields).
      * @maxLength 50
      */
     identifier?: string | null;
-    /** Field type. */
+    /**
+     * Field type.
+     *
+     * `INPUT` fields collect data from submitters and are configured in `input_options`.
+     * `DISPLAY` fields show information without collecting data and are configured in `display_options`.
+     */
     fieldType?: FieldTypeWithLiterals;
 }
 /** @oneof */
@@ -1391,11 +1434,23 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
     arrayOptions?: _Array;
     /** Object input field settings. */
     objectOptions?: _Object;
-    /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
+    /**
+     * File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
+     *
+     * > **Note:** File upload and signature fields are premium features. The site must have a Core premium plan or higher. Creating a form schema with one of these fields on a site without a qualifying plan fails.
+     */
     wixFileOptions?: WixFile;
-    /** Payment input field settings. */
+    /**
+     * Payment input field settings.
+     *
+     * > **Note:** Payment fields are premium features that also depend on another app. The site must have a Core premium plan or higher, and the Wix eCommerce app must be installed. Creating a form schema with a payment field on a site that doesn't meet both requirements fails.
+     */
     paymentOptions?: Payment;
-    /** Scheduling input field settings. */
+    /**
+     * Scheduling input field settings.
+     *
+     * > **Note:** Scheduling fields require the Wix Meetings app to be installed on the site. Creating a form schema with a scheduling field on a site without the app fails.
+     */
     schedulingOptions?: Scheduling;
     /** Address input field settings. */
     addressOptions?: Address;
@@ -1431,7 +1486,14 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
      * Default: `false`
      */
     required?: boolean;
-    /** Type of the input field that determines what kind of data it collects. */
+    /**
+     * Type of the input field that determines what kind of data it collects.
+     *
+     * `input_type` selects which options object applies. For example, `STRING` is configured in `string_options`, and `PAYMENT` in `payment_options`.
+     * That options object then sets a `component_type`, which selects the UI component and its own nested settings object.
+     *
+     * For which combinations produce which field, see [About Form Fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields).
+     */
     inputType?: InputTypeWithLiterals;
     /**
      * Mapping configuration for automatically saving field values to contact properties.
@@ -1458,11 +1520,23 @@ interface InputFieldInputTypeOptionsOneOf {
     arrayOptions?: _Array;
     /** Object input field settings. */
     objectOptions?: _Object;
-    /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
+    /**
+     * File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
+     *
+     * > **Note:** File upload and signature fields are premium features. The site must have a Core premium plan or higher. Creating a form schema with one of these fields on a site without a qualifying plan fails.
+     */
     wixFileOptions?: WixFile;
-    /** Payment input field settings. */
+    /**
+     * Payment input field settings.
+     *
+     * > **Note:** Payment fields are premium features that also depend on another app. The site must have a Core premium plan or higher, and the Wix eCommerce app must be installed. Creating a form schema with a payment field on a site that doesn't meet both requirements fails.
+     */
     paymentOptions?: Payment;
-    /** Scheduling input field settings. */
+    /**
+     * Scheduling input field settings.
+     *
+     * > **Note:** Scheduling fields require the Wix Meetings app to be installed on the site. Creating a form schema with a scheduling field on a site without the app fails.
+     */
     schedulingOptions?: Scheduling;
     /** Address input field settings. */
     addressOptions?: Address;
@@ -1527,7 +1601,7 @@ interface StringTypeFormatOptionsOneOf {
     phoneOptions?: PhoneConstraints;
 }
 declare enum FormatEnumFormat {
-    /** Unknown format. */
+    /** No format constraint. This is the default, and the value a field reads back with when it doesn't restrict its format. */
     UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
     /** Date format. */
     DATE = "DATE",
@@ -5969,7 +6043,11 @@ interface _String extends _StringComponentTypeOptionsOneOf {
     timeInputOptions?: TimeInput;
     /** Date picker component settings. */
     datePickerOptions?: DatePicker;
-    /** Services dropdown component settings. */
+    /**
+     * Services dropdown component settings. Each option's `value` is a Wix Services service ID.
+     *
+     * > **Note:** Service fields require the Wix Services app to be installed on the site. Creating a form schema with a service field on a site without the app fails.
+     */
     servicesDropdownOptions?: ServicesDropdown;
     /** Password component settings. */
     passwordOptions?: Password;
@@ -5996,7 +6074,11 @@ interface _StringComponentTypeOptionsOneOf {
     timeInputOptions?: TimeInput;
     /** Date picker component settings. */
     datePickerOptions?: DatePicker;
-    /** Services dropdown component settings. */
+    /**
+     * Services dropdown component settings. Each option's `value` is a Wix Services service ID.
+     *
+     * > **Note:** Service fields require the Wix Services app to be installed on the site. Creating a form schema with a service field on a site without the app fails.
+     */
     servicesDropdownOptions?: ServicesDropdown;
     /** Password component settings. */
     passwordOptions?: Password;
@@ -6036,7 +6118,11 @@ interface _Array extends _ArrayComponentTypeOptionsOneOf {
     checkboxGroupOptions?: CheckboxGroup;
     /** Tags component settings. */
     tagsOptions?: ComponentsTags;
-    /** Services checkbox group input field */
+    /**
+     * Services checkbox group component settings. Each option's `value` is a Wix Services service ID.
+     *
+     * > **Note:** Service fields require the Wix Services app to be installed on the site. Creating a form schema with a service field on a site without the app fails.
+     */
     servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
     /** Validation configuration for the array input. */
     validation?: ArrayType;
@@ -6049,7 +6135,11 @@ interface _ArrayComponentTypeOptionsOneOf {
     checkboxGroupOptions?: CheckboxGroup;
     /** Tags component settings. */
     tagsOptions?: ComponentsTags;
-    /** Services checkbox group input field */
+    /**
+     * Services checkbox group component settings. Each option's `value` is a Wix Services service ID.
+     *
+     * > **Note:** Service fields require the Wix Services app to be installed on the site. Creating a form schema with a service field on a site without the app fails.
+     */
     servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
 }
 interface _Object {
@@ -6982,14 +7072,22 @@ interface SubmissionValidationErrorsDetails {
 }
 interface ValidationError {
     /**
-     * Path indicating the source of the error, such as `submission.submissions.email`
+     * Path to the value that failed validation, relative to the submission's values.
+     *
+     * For a top-level field this is the field's `target`, such as `email`. For a value nested inside a field, the path continues with `/`, such as `address/postal_code` for an address subfield, or `attachments/0/fileId` for an element of an array field.
      * @maxLength 1000
      */
     errorPath?: string;
-    /** Error type. */
+    /**
+     * Error type.
+     *
+     * Switch on this rather than parsing `error_message`, which carries the underlying validator's wording and isn't a stable contract.
+     */
     errorType?: ErrorTypeWithLiterals;
     /**
-     * Error message.
+     * Human readable description of the error, in English.
+     *
+     * This comes from the schema validator and is meant for debugging. It isn't localized and its wording can change, so don't parse it or show it to submitters. Use `error_type` to decide what to display.
      * @maxLength 1000
      */
     errorMessage?: string;