@wix/auto_sdk_forms_submissions 1.0.149 → 1.0.151

package/build/internal/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { hG as UpsertContactFromSubmissionRequest$1, a as UpsertContactFromSubmissionResponse$1, hI as CreateSubmissionRequest$1, hJ as CreateSubmissionResponse$1, hV as GetSubmissionRequest$1, hW as GetSubmissionResponse$1, hZ as UpdateSubmissionRequest$1, h_ as UpdateSubmissionResponse$1, h$ as ConfirmSubmissionRequest$1, f as ConfirmSubmissionResponse$1, i0 as DeleteSubmissionRequest$1, i1 as DeleteSubmissionResponse$1, i2 as BulkDeleteSubmissionRequest$1, g as BulkDeleteSubmissionResponse$1, i4 as RestoreSubmissionFromTrashBinRequest$1, R as RestoreSubmissionFromTrashBinResponse$1, i5 as RemoveSubmissionFromTrashBinRequest$1, i6 as RemoveSubmissionFromTrashBinResponse$1, i7 as BulkRemoveSubmissionFromTrashBinRequest$1, i as BulkRemoveSubmissionFromTrashBinResponse$1, i9 as ListDeletedSubmissionsRequest$1, j as ListDeletedSubmissionsResponse$1, ia as GetDeletedSubmissionRequest$1, G as GetDeletedSubmissionResponse$1, ib as QuerySubmissionRequest$1, l as QuerySubmissionResponse$1, ic as SearchSubmissionsByNamespaceRequest$1, S as SearchSubmissionsByNamespaceResponse$1, ig as QuerySubmissionsByNamespaceRequest$1, ih as QuerySubmissionsByNamespaceResponse$1, ik as CountSubmissionsByFilterRequest$1, o as CountSubmissionsByFilterResponse$1, im as CountSubmissionsRequest$1, q as CountSubmissionsResponse$1, io as CountDeletedSubmissionsRequest$1, s as CountDeletedSubmissionsResponse$1, iq as GetMediaUploadURLRequest$1, t as GetMediaUploadURLResponse$1, ir as BulkMarkSubmissionsAsSeenRequest$1, u as BulkMarkSubmissionsAsSeenResponse$1, is as GetSubmissionDownloadUrlRequest$1, v as GetSubmissionDownloadUrlResponse$1, iw as DownloadSubmissionRequest$1, w as RawHttpResponse$1, iy as GetFormattedSubmissionRequest$1, x as GetFormattedSubmissionResponse$1, iD as UpdateExtendedFieldsRequest$1, z as UpdateExtendedFieldsResponse$1, iE as BulkUpdateFormSubmissionTagsRequest$1, E as BulkUpdateFormSubmissionTagsResponse$1, iG as BulkUpdateFormSubmissionTagsByFilterRequest$1, I as BulkUpdateFormSubmissionTagsByFilterResponse$1, iH as ValidateFormSubmissionRequest$1, J as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-VEnQJRaC.js';
+import { hG as UpsertContactFromSubmissionRequest$1, a as UpsertContactFromSubmissionResponse$1, hI as CreateSubmissionRequest$1, hJ as CreateSubmissionResponse$1, hV as GetSubmissionRequest$1, hW as GetSubmissionResponse$1, hZ as UpdateSubmissionRequest$1, h_ as UpdateSubmissionResponse$1, h$ as ConfirmSubmissionRequest$1, f as ConfirmSubmissionResponse$1, i0 as DeleteSubmissionRequest$1, i1 as DeleteSubmissionResponse$1, i2 as BulkDeleteSubmissionRequest$1, g as BulkDeleteSubmissionResponse$1, i4 as RestoreSubmissionFromTrashBinRequest$1, R as RestoreSubmissionFromTrashBinResponse$1, i5 as RemoveSubmissionFromTrashBinRequest$1, i6 as RemoveSubmissionFromTrashBinResponse$1, i7 as BulkRemoveSubmissionFromTrashBinRequest$1, i as BulkRemoveSubmissionFromTrashBinResponse$1, i9 as ListDeletedSubmissionsRequest$1, j as ListDeletedSubmissionsResponse$1, ia as GetDeletedSubmissionRequest$1, G as GetDeletedSubmissionResponse$1, ib as QuerySubmissionRequest$1, l as QuerySubmissionResponse$1, ic as SearchSubmissionsByNamespaceRequest$1, S as SearchSubmissionsByNamespaceResponse$1, ig as QuerySubmissionsByNamespaceRequest$1, ih as QuerySubmissionsByNamespaceResponse$1, ik as CountSubmissionsByFilterRequest$1, o as CountSubmissionsByFilterResponse$1, im as CountSubmissionsRequest$1, q as CountSubmissionsResponse$1, io as CountDeletedSubmissionsRequest$1, s as CountDeletedSubmissionsResponse$1, iq as GetMediaUploadURLRequest$1, t as GetMediaUploadURLResponse$1, ir as BulkMarkSubmissionsAsSeenRequest$1, u as BulkMarkSubmissionsAsSeenResponse$1, is as GetSubmissionDownloadUrlRequest$1, v as GetSubmissionDownloadUrlResponse$1, iw as DownloadSubmissionRequest$1, w as RawHttpResponse$1, iy as GetFormattedSubmissionRequest$1, x as GetFormattedSubmissionResponse$1, iD as UpdateExtendedFieldsRequest$1, z as UpdateExtendedFieldsResponse$1, iE as BulkUpdateFormSubmissionTagsRequest$1, E as BulkUpdateFormSubmissionTagsResponse$1, iG as BulkUpdateFormSubmissionTagsByFilterRequest$1, I as BulkUpdateFormSubmissionTagsByFilterResponse$1, iH as ValidateFormSubmissionRequest$1, J as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-Cboh5KxF.js';
 import '@wix/sdk-types';
 
 /** Form submission that was created or retrieved. */
@@ -41,7 +41,7 @@ interface FormSubmission {
      *
      * 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).
+     * For the full mapping, see [About Submission Values](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/about-submission-values).
      */
     submissions?: Record<string, any>;
     /**
@@ -727,7 +727,7 @@ interface Form {
      * 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.
+     * Every field in `formFields`, including the submit button, must be placed by a layout item whose `fieldId` 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
@@ -844,10 +844,10 @@ interface Form {
     sourceFormId?: string | null;
     /**
      * Whether the form is effectively active — `true` only when the user has not disabled the form
-     * **and** no system service has placed an `activation_block` on it.
+     * **and** no system service has placed an `activationBlock` on it.
      *
      * Writing `enabled: true` records the user's intent to activate the form, but the value read
-     * back may still be `false` if `activation_block` is present (e.g. a plan restriction is in
+     * back may still be `false` if `activationBlock` is present (for example, a plan restriction is in
      * effect). Once the block is lifted the form becomes active automatically without any additional
      * write.
      *
@@ -884,10 +884,10 @@ interface Form {
      * When present, `enabled` is returned as `false` regardless of what the user set.
      * When absent, `enabled` reflects the user's stored intent exclusively.
      *
-     * Set and cleared only through dedicated internal RPCs (e.g. `BulkUpdateFormsActivationBlock`).
+     * Set and cleared only through dedicated internal RPCs (for example, `BulkUpdateFormsActivationBlock`).
      * Cannot be written via `UpdateForm` — attempts to include it in the field mask are rejected.
      *
-     * Format: `<OWNER_APP>_<REASON>`, e.g. `FORM_APP_PREMIUM_FEATURE_VIOLATION`, `FORM_APP_FORM_COUNT_EXCEEDED`.
+     * Format: `<OWNER_APP>_<REASON>`, such as `FORM_APP_PREMIUM_FEATURE_VIOLATION`, `FORM_APP_FORM_COUNT_EXCEEDED`.
      * @internal
      * @readonly
      * @maxLength 100
@@ -1492,7 +1492,7 @@ interface Field extends FieldFieldTypeOptionsOneOf {
     /**
      * 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.
+     * 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 `fieldId` still match after the form schema is stored. IDs must be unique in the form.
      * @format GUID
      * @immutable
      */
@@ -1507,7 +1507,7 @@ interface Field extends FieldFieldTypeOptionsOneOf {
      * 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.
+     * 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 `formFields`, 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.
@@ -1519,8 +1519,8 @@ interface Field extends FieldFieldTypeOptionsOneOf {
     /**
      * 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`.
+     * `INPUT` fields collect data from submitters and are configured in `inputOptions`.
+     * `DISPLAY` fields show information without collecting data and are configured in `displayOptions`.
      */
     fieldType?: FieldTypeWithLiterals;
 }
@@ -1617,8 +1617,8 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
     /**
      * 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.
+     * `inputType` selects which options object applies. For example, `STRING` is configured in `stringOptions`, and `PAYMENT` in `paymentOptions`.
+     * That options object then sets a `componentType`, 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).
      */
@@ -5819,6 +5819,7 @@ interface FormLayout {
 interface BreakPoint {
     /**
      * Configuration for the layout of items in the breakpoint.
+     * Every field of the step must have exactly 1 corresponding item in each breakpoint that is defined.
      * @maxSize 500
      */
     items?: ItemLayout[];
@@ -5845,13 +5846,18 @@ interface ItemLayout extends ItemLayoutItemOneOf {
     fieldId?: string;
     /** Group configuration for positioning multiple fields as a single layout unit. */
     group?: Group;
-    /** Row position in the grid where this item is placed. */
+    /**
+     * Row position in the grid where this item is placed.
+     *
+     * Required. `row`, `column`, `width`, and `height` have no defaults. An item missing
+     * any of them isn't rendered, so the field doesn't appear in the form.
+     */
     row?: number | null;
-    /** Column position in the grid where this item is placed. */
+    /** Column position in the grid where this item is placed. Required. */
     column?: number | null;
-    /** Width of the item in grid units. */
+    /** Width of the item, in grid columns. Full width in the default 12-column grid is `12`. Required. */
     width?: number | null;
-    /** Height of the item in grid units. */
+    /** Height of the item, in grid rows. `1` for most field types. Required. */
     height?: number | null;
 }
 /** @oneof */
@@ -6273,7 +6279,11 @@ interface _String extends _StringComponentTypeOptionsOneOf {
     servicesDropdownOptions?: ServicesDropdown;
     /** Password component settings. */
     passwordOptions?: Password;
-    /** Validation configuration for the string input. */
+    /**
+     * Validation configuration for the string input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: StringType;
     /** Component type of the string input field. */
     componentType?: StringComponentTypeWithLiterals;
@@ -6315,7 +6325,11 @@ interface _Number extends _NumberComponentTypeOptionsOneOf {
     numberInputOptions?: NumberInput;
     /** Rating input settings. */
     ratingInputOptions?: RatingInput;
-    /** Validation configuration for the number input. */
+    /**
+     * Validation configuration for the number input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: NumberType;
     /** Component type of the number input field. */
     componentType?: NumberComponentTypeWithLiterals;
@@ -6335,7 +6349,11 @@ interface _NumberComponentTypeOptionsOneOf {
 interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
     /** Checkbox component settings. */
     checkboxOptions?: Checkbox;
-    /** Validation configuration for the boolean input. */
+    /**
+     * Validation configuration for the boolean input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: BooleanType;
     /** Component type of the boolean input field. */
     componentType?: BooleanComponentTypeWithLiterals;
@@ -6356,7 +6374,11 @@ interface _Array extends _ArrayComponentTypeOptionsOneOf {
      * > **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 configuration for the array input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: ArrayType;
     /** Component type of the array input field. */
     componentType?: ArrayComponentTypeWithLiterals;
@@ -6380,7 +6402,11 @@ interface _ArrayComponentTypeOptionsOneOf {
     servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
 }
 interface _Object {
-    /** Validation configuration for the object input. */
+    /**
+     * Validation configuration for the object input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: ObjectType;
 }
 interface WixFile extends WixFileComponentTypeOptionsOneOf {
@@ -6390,7 +6416,11 @@ interface WixFile extends WixFileComponentTypeOptionsOneOf {
     signatureOptions?: Signature;
     /** Component type of the file input field. */
     componentType?: WixFileComponentTypeWithLiterals;
-    /** Validation configuration for the file input. */
+    /**
+     * Validation configuration for the file input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: FileType;
 }
 /** @oneof */
@@ -6411,7 +6441,11 @@ interface Payment extends PaymentComponentTypeOptionsOneOf {
     fixedPaymentOptions?: FixedPayment;
     /** Component type of the payment input field. */
     componentType?: PaymentComponentTypeWithLiterals;
-    /** Validation configuration for the payment input. */
+    /**
+     * Validation configuration for the payment input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: PaymentType;
 }
 /** @oneof */
@@ -6441,7 +6475,11 @@ interface Address extends AddressComponentTypeOptionsOneOf {
     multilineAddressOptions?: MultilineAddress;
     /** Component type of the multiline address field. */
     componentType?: ComponentTypeWithLiterals;
-    /** Validation configuration for the multiline address input. */
+    /**
+     * Validation configuration for the multiline address input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: MultilineAddressValidation;
 }
 /** @oneof */
@@ -6454,7 +6492,11 @@ interface ObjectArray extends ObjectArrayComponentTypeOptionsOneOf {
     repeaterOptions?: Repeater;
     /** Component type of the object array input. */
     componentType?: ObjectArrayComponentTypeWithLiterals;
-    /** Validation configuration for the object array input. */
+    /**
+     * Validation configuration for the object array input.
+     *
+     * Always include this object, even when it's empty: `{}`.
+     */
     validation?: ObjectArrayType;
 }
 /** @oneof */
@@ -7328,13 +7370,13 @@ interface ValidationError {
     /**
      * Error type.
      *
-     * Switch on this rather than parsing `error_message`, which carries the underlying validator's wording and isn't a stable contract.
+     * Switch on this rather than parsing `errorMessage`, which carries the underlying validator's wording and isn't a stable contract.
      */
     errorType?: ErrorTypeWithLiterals;
     /**
      * 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.
+     * 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 `errorType` to decide what to display.
      * @maxLength 1000
      */
     errorMessage?: string;
@@ -8054,7 +8096,7 @@ interface UpdateExtendedFieldsResponse {
      * @maxLength 50
      */
     namespace?: string;
-    /** only data from UpdateExtendedFieldsRequest namespace_data */
+    /** only data from UpdateExtendedFieldsRequest `namespaceData` */
     namespaceData?: Record<string, any> | null;
 }
 interface BulkUpdateFormSubmissionTagsRequest {