@wix/auto_sdk_forms_submissions 1.0.155 → 1.0.157

package/build/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, iF as BulkUpdateFormSubmissionTagsResponse$1, iH as BulkUpdateFormSubmissionTagsByFilterRequest$1, iI as BulkUpdateFormSubmissionTagsByFilterResponse$1, iJ as ValidateFormSubmissionRequest$1, A as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-5DzKQUIB.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, iF as BulkUpdateFormSubmissionTagsResponse$1, iH as BulkUpdateFormSubmissionTagsByFilterRequest$1, iI as BulkUpdateFormSubmissionTagsByFilterResponse$1, iJ as ValidateFormSubmissionRequest$1, A as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-C6InzFwD.js';
 import '@wix/sdk-types';
 
 /** Form submission that was created or retrieved. */
@@ -16,7 +16,12 @@ interface FormSubmission {
      */
     formId?: string;
     /**
-     * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.
+     * The app which the form submissions belong to. A submission inherits the namespace from its form schema, so you can't set it directly.
+     *
+     * For example, a submission of a form visible in the Wix Forms app has the namespace `wix.form_app.form`, the namespace of the Wix Forms app, whose app ID is `225dd912-7dea-4738-8688-4b8c6955ffc2`.
+     *
+     * See a list of namespaces for [apps made by Wix](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction#namespaces-of-apps-made-by-wix) section.
+     * To retrieve the ID for a Wix app, see [Apps Created By Wix](https://dev.wix.com/docs/rest/articles/get-started/apps-created-by-wix).
      * @minLength 10
      * @maxLength 50
      * @readonly
@@ -37,7 +42,7 @@ interface FormSubmission {
      *
      * 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.
+     * 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. A choice field submits an option's `value`, not its ID or its label.
      *
      * 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.
      *
@@ -723,9 +728,11 @@ interface Form {
     extendedFields?: ExtendedFields;
     /**
      * Unique identifier for the app that owns this form schema.
-     * For example, `wix.form_app.form` for Wix Forms.
+     *
+     * For example, for creating a form visible in the Wix Forms app, use `wix.form_app.form`, the namespace of the Wix Forms app, whose app ID is `225dd912-7dea-4738-8688-4b8c6955ffc2`.
      *
      * See a list of namespaces for [apps made by Wix](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction#namespaces-of-apps-made-by-wix) section.
+     * To retrieve the ID for a Wix app, see [Apps Created By Wix](https://dev.wix.com/docs/rest/articles/get-started/apps-created-by-wix).
      * @minLength 10
      * @maxLength 50
      * @immutable
@@ -1399,7 +1406,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 `formFields`, and neither the field nor its submitted values appear in the Wix dashboard.
+     * Wix accepts an unrecognized value, such as a custom string or a GUID: the request succeeds, and Wix stores the field, returns it in `formFields`, and accepts its submissions. But Wix apps use `identifier` to recognize a field, so the Wix Forms editor doesn't render it, and the Wix user can't see or edit that field. A form whose fields all carry unrecognized identifiers opens empty in the editor. Always map a field onto a known identifier, and set its display name with the component's label.
      *
      * 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.
@@ -1493,6 +1500,8 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
     /**
      * Whether the field is required for form submission.
      *
+     * Set this on `inputOptions`, alongside `target` and `inputType`. A `required` placed inside a validation object, such as `stringOptions.validation`, isn't part of the schema and has no effect.
+     *
      * Default: `false`
      */
     required?: boolean;
@@ -6855,6 +6864,9 @@ interface Rule {
     /**
      * Conditional expression that determines when this rule should be applied.
      * The overrides defined in this rule are applied when this expression evaluates to true.
+     *
+     * The root of the expression must be an `and` or `or` group. To evaluate a
+     * single condition, wrap it in a group with 1 condition.
      */
     expression?: ConditionNode;
     /**
@@ -6930,12 +6942,19 @@ interface FieldOverridePropertyTypeOptionsOneOf {
     /** Configuration for changing the allowed values of a field. */
     allowedValuesOptions?: AllowedValuesOptions;
 }
+/**
+ * Node of a rule's conditional expression. Either a logical group of nested
+ * nodes, or a single condition.
+ *
+ * The root node of a rule's expression must be an `and` or `or` group.
+ * A single condition is only supported in nested nodes.
+ */
 interface ConditionNode extends ConditionNodeNodeOneOf {
     /** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
     and?: AndCondition;
     /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
     or?: OrCondition;
-    /** Single condition to evaluate. */
+    /** Single condition to evaluate. Not supported as the root of a rule's expression. */
     condition?: Condition;
 }
 /** @oneof */
@@ -6944,7 +6963,7 @@ interface ConditionNodeNodeOneOf {
     and?: AndCondition;
     /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
     or?: OrCondition;
-    /** Single condition to evaluate. */
+    /** Single condition to evaluate. Not supported as the root of a rule's expression. */
     condition?: Condition;
 }
 interface AndCondition {