@wix/auto_sdk_forms_submissions 1.0.156 → 1.0.158
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{forms-v4-submission-submissions.universal-Dfm8IKXU.d.ts → forms-v4-submission-submissions.universal-B1EWr26L.d.ts} +64 -29
- package/build/cjs/index.d.ts +24 -24
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +27 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{forms-v4-submission-submissions.universal-Dfm8IKXU.d.mts → forms-v4-submission-submissions.universal-B1EWr26L.d.mts} +64 -29
- package/build/es/index.d.mts +24 -24
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +27 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{forms-v4-submission-submissions.universal-JoamIElR.d.ts → forms-v4-submission-submissions.universal-BY0FSUS3.d.ts} +66 -31
- package/build/internal/cjs/index.d.ts +26 -26
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +27 -5
- package/build/internal/es/{forms-v4-submission-submissions.universal-JoamIElR.d.mts → forms-v4-submission-submissions.universal-BY0FSUS3.d.mts} +66 -31
- package/build/internal/es/index.d.mts +26 -26
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +27 -5
- package/package.json +2 -2
|
@@ -97,6 +97,14 @@ interface FormSubmission {
|
|
|
97
97
|
* This object is only applicable when submitting a form that creates a booking appointment.
|
|
98
98
|
*/
|
|
99
99
|
appointmentDetails?: AppointmentDetails;
|
|
100
|
+
/**
|
|
101
|
+
* ID of the child site the submission was made on.
|
|
102
|
+
*
|
|
103
|
+
* Only present when the form was submitted on a site that shares its data with a parent site. In that case submissions from every child site are stored on the parent site, and this field identifies which child site the submission came from.
|
|
104
|
+
* @format GUID
|
|
105
|
+
* @readonly
|
|
106
|
+
*/
|
|
107
|
+
childMetaSiteId?: string | null;
|
|
100
108
|
}
|
|
101
109
|
declare enum SubmissionStatus {
|
|
102
110
|
/** A submission is created, but has not yet been recorded in the Wix Forms collection. */
|
|
@@ -758,9 +766,11 @@ interface Form {
|
|
|
758
766
|
extendedFields?: ExtendedFields;
|
|
759
767
|
/**
|
|
760
768
|
* Unique identifier for the app that owns this form schema.
|
|
761
|
-
*
|
|
769
|
+
*
|
|
770
|
+
* 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`.
|
|
762
771
|
*
|
|
763
772
|
* 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.
|
|
773
|
+
* 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).
|
|
764
774
|
* @minLength 10
|
|
765
775
|
* @maxLength 50
|
|
766
776
|
* @immutable
|
|
@@ -1479,7 +1489,7 @@ interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
1479
1489
|
* Identification for the field, describing its purpose. For example, `TEXT_INPUT` or `CONTACTS_EMAIL`.
|
|
1480
1490
|
*
|
|
1481
1491
|
* Set this to the known value for the kind of field you're creating.
|
|
1482
|
-
*
|
|
1492
|
+
* 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.
|
|
1483
1493
|
*
|
|
1484
1494
|
* Several fields share a general-purpose `componentType`, so `identifier` is often the only value that distinguishes them.
|
|
1485
1495
|
* 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.
|
|
@@ -1583,6 +1593,8 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
1583
1593
|
/**
|
|
1584
1594
|
* Whether the field is required for form submission.
|
|
1585
1595
|
*
|
|
1596
|
+
* 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.
|
|
1597
|
+
*
|
|
1586
1598
|
* Default: `false`
|
|
1587
1599
|
*/
|
|
1588
1600
|
required?: boolean;
|
|
@@ -7002,6 +7014,9 @@ interface Rule {
|
|
|
7002
7014
|
/**
|
|
7003
7015
|
* Conditional expression that determines when this rule should be applied.
|
|
7004
7016
|
* The overrides defined in this rule are applied when this expression evaluates to true.
|
|
7017
|
+
*
|
|
7018
|
+
* The root of the expression must be an `and` or `or` group. To evaluate a
|
|
7019
|
+
* single condition, wrap it in a group with 1 condition.
|
|
7005
7020
|
*/
|
|
7006
7021
|
expression?: ConditionNode;
|
|
7007
7022
|
/**
|
|
@@ -7077,12 +7092,19 @@ interface FieldOverridePropertyTypeOptionsOneOf {
|
|
|
7077
7092
|
/** Configuration for changing the allowed values of a field. */
|
|
7078
7093
|
allowedValuesOptions?: AllowedValuesOptions;
|
|
7079
7094
|
}
|
|
7095
|
+
/**
|
|
7096
|
+
* Node of a rule's conditional expression. Either a logical group of nested
|
|
7097
|
+
* nodes, or a single condition.
|
|
7098
|
+
*
|
|
7099
|
+
* The root node of a rule's expression must be an `and` or `or` group.
|
|
7100
|
+
* A single condition is only supported in nested nodes.
|
|
7101
|
+
*/
|
|
7080
7102
|
interface ConditionNode extends ConditionNodeNodeOneOf {
|
|
7081
7103
|
/** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
|
|
7082
7104
|
and?: AndCondition;
|
|
7083
7105
|
/** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
|
|
7084
7106
|
or?: OrCondition;
|
|
7085
|
-
/** Single condition to evaluate. */
|
|
7107
|
+
/** Single condition to evaluate. Not supported as the root of a rule's expression. */
|
|
7086
7108
|
condition?: Condition;
|
|
7087
7109
|
}
|
|
7088
7110
|
/** @oneof */
|
|
@@ -7091,7 +7113,7 @@ interface ConditionNodeNodeOneOf {
|
|
|
7091
7113
|
and?: AndCondition;
|
|
7092
7114
|
/** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
|
|
7093
7115
|
or?: OrCondition;
|
|
7094
|
-
/** Single condition to evaluate. */
|
|
7116
|
+
/** Single condition to evaluate. Not supported as the root of a rule's expression. */
|
|
7095
7117
|
condition?: Condition;
|
|
7096
7118
|
}
|
|
7097
7119
|
interface AndCondition {
|
|
@@ -8590,7 +8612,7 @@ declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEnvelope)
|
|
|
8590
8612
|
* @applicableIdentity APP
|
|
8591
8613
|
* @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
|
|
8592
8614
|
*/
|
|
8593
|
-
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`,
|
|
8615
|
+
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`, 1>>;
|
|
8594
8616
|
interface UpsertContactFromSubmissionOptions {
|
|
8595
8617
|
/**
|
|
8596
8618
|
* Optional contact id to which submission should be mapped.
|
|
@@ -8615,7 +8637,7 @@ interface UpsertContactFromSubmissionOptions {
|
|
|
8615
8637
|
* @returns The created submission.
|
|
8616
8638
|
* @fqn wix.forms.v4.FormSubmissionService.CreateSubmission
|
|
8617
8639
|
*/
|
|
8618
|
-
declare function createSubmission(submission: NonNullablePaths<FormSubmission, `formId`,
|
|
8640
|
+
declare function createSubmission(submission: NonNullablePaths<FormSubmission, `formId`, 0>, options?: CreateSubmissionOptions): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`, 2> & {
|
|
8619
8641
|
__applicationErrorsType?: CreateSubmissionApplicationErrors;
|
|
8620
8642
|
__validationErrorsType?: CreateSubmissionValidationErrors;
|
|
8621
8643
|
}>;
|
|
@@ -8639,7 +8661,7 @@ interface CreateSubmissionOptions {
|
|
|
8639
8661
|
* @returns The retrieved submission.
|
|
8640
8662
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmission
|
|
8641
8663
|
*/
|
|
8642
|
-
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`,
|
|
8664
|
+
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`, 2>>;
|
|
8643
8665
|
/**
|
|
8644
8666
|
* Updates a submission.
|
|
8645
8667
|
*
|
|
@@ -8657,7 +8679,7 @@ declare function getSubmission(submissionId: string): Promise<NonNullablePaths<F
|
|
|
8657
8679
|
* @returns The updated submission.
|
|
8658
8680
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateSubmission
|
|
8659
8681
|
*/
|
|
8660
|
-
declare function updateSubmission(_id: string, submission: NonNullablePaths<UpdateSubmission, `formId` | `revision`,
|
|
8682
|
+
declare function updateSubmission(_id: string, submission: NonNullablePaths<UpdateSubmission, `formId` | `revision`, 0>): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`, 2> & {
|
|
8661
8683
|
__validationErrorsType?: UpdateSubmissionValidationErrors;
|
|
8662
8684
|
}>;
|
|
8663
8685
|
interface UpdateSubmission {
|
|
@@ -8755,6 +8777,14 @@ interface UpdateSubmission {
|
|
|
8755
8777
|
* This object is only applicable when submitting a form that creates a booking appointment.
|
|
8756
8778
|
*/
|
|
8757
8779
|
appointmentDetails?: AppointmentDetails;
|
|
8780
|
+
/**
|
|
8781
|
+
* ID of the child site the submission was made on.
|
|
8782
|
+
*
|
|
8783
|
+
* Only present when the form was submitted on a site that shares its data with a parent site. In that case submissions from every child site are stored on the parent site, and this field identifies which child site the submission came from.
|
|
8784
|
+
* @format GUID
|
|
8785
|
+
* @readonly
|
|
8786
|
+
*/
|
|
8787
|
+
childMetaSiteId?: string | null;
|
|
8758
8788
|
}
|
|
8759
8789
|
/**
|
|
8760
8790
|
* Confirms a submission.
|
|
@@ -8770,7 +8800,7 @@ interface UpdateSubmission {
|
|
|
8770
8800
|
* @applicableIdentity APP
|
|
8771
8801
|
* @fqn wix.forms.v4.FormSubmissionService.ConfirmSubmission
|
|
8772
8802
|
*/
|
|
8773
|
-
declare function confirmSubmission(submissionId: string): Promise<NonNullablePaths<ConfirmSubmissionResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`,
|
|
8803
|
+
declare function confirmSubmission(submissionId: string): Promise<NonNullablePaths<ConfirmSubmissionResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`, 3>>;
|
|
8774
8804
|
/**
|
|
8775
8805
|
* Deletes a submission.
|
|
8776
8806
|
*
|
|
@@ -8806,7 +8836,7 @@ interface DeleteSubmissionOptions {
|
|
|
8806
8836
|
* @applicableIdentity APP
|
|
8807
8837
|
* @fqn wix.forms.v4.FormSubmissionService.BulkDeleteSubmission
|
|
8808
8838
|
*/
|
|
8809
|
-
declare function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise<NonNullablePaths<BulkDeleteSubmissionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
8839
|
+
declare function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise<NonNullablePaths<BulkDeleteSubmissionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
8810
8840
|
interface BulkDeleteSubmissionOptions {
|
|
8811
8841
|
/**
|
|
8812
8842
|
* Submission ids.
|
|
@@ -8833,7 +8863,7 @@ interface BulkDeleteSubmissionOptions {
|
|
|
8833
8863
|
* @applicableIdentity APP
|
|
8834
8864
|
* @fqn wix.forms.v4.FormSubmissionService.RestoreSubmissionFromTrashBin
|
|
8835
8865
|
*/
|
|
8836
|
-
declare function restoreSubmissionFromTrashBin(submissionId: string): Promise<NonNullablePaths<RestoreSubmissionFromTrashBinResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`,
|
|
8866
|
+
declare function restoreSubmissionFromTrashBin(submissionId: string): Promise<NonNullablePaths<RestoreSubmissionFromTrashBinResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`, 3>>;
|
|
8837
8867
|
/**
|
|
8838
8868
|
* Remove deleted submission
|
|
8839
8869
|
* @param submissionId - ID of the submission to restore.
|
|
@@ -8855,7 +8885,7 @@ declare function removeSubmissionFromTrashBin(submissionId: string): Promise<voi
|
|
|
8855
8885
|
* @applicableIdentity APP
|
|
8856
8886
|
* @fqn wix.forms.v4.FormSubmissionService.BulkRemoveSubmissionFromTrashBin
|
|
8857
8887
|
*/
|
|
8858
|
-
declare function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise<NonNullablePaths<BulkRemoveSubmissionFromTrashBinResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
8888
|
+
declare function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise<NonNullablePaths<BulkRemoveSubmissionFromTrashBinResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
8859
8889
|
interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
8860
8890
|
/**
|
|
8861
8891
|
* Submission ids.
|
|
@@ -8875,7 +8905,7 @@ interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
|
8875
8905
|
* @applicableIdentity APP
|
|
8876
8906
|
* @fqn wix.forms.v4.FormSubmissionService.ListDeletedSubmissions
|
|
8877
8907
|
*/
|
|
8878
|
-
declare function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise<NonNullablePaths<ListDeletedSubmissionsResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`,
|
|
8908
|
+
declare function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise<NonNullablePaths<ListDeletedSubmissionsResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`, 3>>;
|
|
8879
8909
|
interface ListDeletedSubmissionsOptions {
|
|
8880
8910
|
/**
|
|
8881
8911
|
* Submission ids.
|
|
@@ -8902,7 +8932,7 @@ interface ListDeletedSubmissionsOptions {
|
|
|
8902
8932
|
* @applicableIdentity APP
|
|
8903
8933
|
* @fqn wix.forms.v4.FormSubmissionService.GetDeletedSubmission
|
|
8904
8934
|
*/
|
|
8905
|
-
declare function getDeletedSubmission(submissionId: string): Promise<NonNullablePaths<GetDeletedSubmissionResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`,
|
|
8935
|
+
declare function getDeletedSubmission(submissionId: string): Promise<NonNullablePaths<GetDeletedSubmissionResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`, 3>>;
|
|
8906
8936
|
/**
|
|
8907
8937
|
* Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace.
|
|
8908
8938
|
* @param query - Query options.
|
|
@@ -8916,7 +8946,7 @@ declare function getDeletedSubmission(submissionId: string): Promise<NonNullable
|
|
|
8916
8946
|
* @replacedBy com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
8917
8947
|
* @targetRemovalDate 2025-04-01
|
|
8918
8948
|
*/
|
|
8919
|
-
declare function querySubmission(query: CursorQuery, options?: QuerySubmissionOptions): Promise<NonNullablePaths<QuerySubmissionResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`,
|
|
8949
|
+
declare function querySubmission(query: CursorQuery, options?: QuerySubmissionOptions): Promise<NonNullablePaths<QuerySubmissionResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`, 3>>;
|
|
8920
8950
|
interface QuerySubmissionOptions {
|
|
8921
8951
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
8922
8952
|
onlyYourOwn?: boolean;
|
|
@@ -9060,11 +9090,11 @@ interface SubmissionsQueryBuilder {
|
|
|
9060
9090
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9061
9091
|
* @param value - Value to compare against.
|
|
9062
9092
|
*/
|
|
9063
|
-
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9093
|
+
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9064
9094
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9065
9095
|
* @param value - Value to compare against.
|
|
9066
9096
|
*/
|
|
9067
|
-
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9097
|
+
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9068
9098
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9069
9099
|
* @param value - Value to compare against.
|
|
9070
9100
|
*/
|
|
@@ -9081,7 +9111,7 @@ interface SubmissionsQueryBuilder {
|
|
|
9081
9111
|
* @param value - Value to compare against.
|
|
9082
9112
|
*/
|
|
9083
9113
|
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
|
|
9084
|
-
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9114
|
+
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9085
9115
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
9086
9116
|
ascending: (...propertyNames: Array<'_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId'>) => SubmissionsQueryBuilder;
|
|
9087
9117
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -9097,7 +9127,7 @@ interface SubmissionsQueryBuilder {
|
|
|
9097
9127
|
* @fqn wix.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
9098
9128
|
* @requiredField query
|
|
9099
9129
|
*/
|
|
9100
|
-
declare function typedQuerySubmissionsByNamespace(query: FormSubmissionQuery, options?: QuerySubmissionsByNamespaceOptions): Promise<NonNullablePaths<QuerySubmissionsByNamespaceResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`,
|
|
9130
|
+
declare function typedQuerySubmissionsByNamespace(query: FormSubmissionQuery, options?: QuerySubmissionsByNamespaceOptions): Promise<NonNullablePaths<QuerySubmissionsByNamespaceResponse, `submissions` | `submissions.${number}.formId` | `submissions.${number}.namespace` | `submissions.${number}.status` | `submissions.${number}.seen` | `submissions.${number}.orderDetails.itemSubtotal` | `submissions.${number}.orderDetails.checkoutId`, 3>>;
|
|
9101
9131
|
interface FormSubmissionQuerySpec extends QuerySpec {
|
|
9102
9132
|
paging: 'cursor';
|
|
9103
9133
|
wql: [
|
|
@@ -9150,6 +9180,11 @@ interface FormSubmissionQuerySpec extends QuerySpec {
|
|
|
9150
9180
|
fields: ['orderDetails.checkoutId'];
|
|
9151
9181
|
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
9152
9182
|
sort: 'BOTH';
|
|
9183
|
+
},
|
|
9184
|
+
{
|
|
9185
|
+
fields: ['childMetaSiteId'];
|
|
9186
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
9187
|
+
sort: 'NONE';
|
|
9153
9188
|
}
|
|
9154
9189
|
];
|
|
9155
9190
|
}
|
|
@@ -9212,7 +9247,7 @@ type FormSubmissionQuery = {
|
|
|
9212
9247
|
* @applicableIdentity APP
|
|
9213
9248
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissionsByFilter
|
|
9214
9249
|
*/
|
|
9215
|
-
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9250
|
+
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9216
9251
|
interface CountSubmissionsByFilterOptions {
|
|
9217
9252
|
/** Free text to match in searchable fields. */
|
|
9218
9253
|
search?: SearchDetails;
|
|
@@ -9231,7 +9266,7 @@ interface CountSubmissionsByFilterOptions {
|
|
|
9231
9266
|
* @applicableIdentity APP
|
|
9232
9267
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissions
|
|
9233
9268
|
*/
|
|
9234
|
-
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9269
|
+
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9235
9270
|
interface CountSubmissionsOptions {
|
|
9236
9271
|
/**
|
|
9237
9272
|
* Status of the submission.
|
|
@@ -9258,7 +9293,7 @@ interface CountSubmissionsOptions {
|
|
|
9258
9293
|
* @applicableIdentity APP
|
|
9259
9294
|
* @fqn wix.forms.v4.FormSubmissionService.CountDeletedSubmissions
|
|
9260
9295
|
*/
|
|
9261
|
-
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`,
|
|
9296
|
+
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`, 2>>;
|
|
9262
9297
|
interface CountDeletedSubmissionsOptions {
|
|
9263
9298
|
/**
|
|
9264
9299
|
* List of statuses of submissions which should be taken into count
|
|
@@ -9286,7 +9321,7 @@ interface CountDeletedSubmissionsOptions {
|
|
|
9286
9321
|
* @applicableIdentity APP
|
|
9287
9322
|
* @fqn wix.forms.v4.FormSubmissionService.GetMediaUploadURL
|
|
9288
9323
|
*/
|
|
9289
|
-
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`,
|
|
9324
|
+
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`, 0>>;
|
|
9290
9325
|
/**
|
|
9291
9326
|
* Marks form submissions as "seen".
|
|
9292
9327
|
*
|
|
@@ -9301,7 +9336,7 @@ declare function getMediaUploadUrl(formId: string, filename: string, mimeType: s
|
|
|
9301
9336
|
* @applicableIdentity APP
|
|
9302
9337
|
* @fqn wix.forms.v4.FormSubmissionService.BulkMarkSubmissionsAsSeen
|
|
9303
9338
|
*/
|
|
9304
|
-
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`,
|
|
9339
|
+
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`, 0>>;
|
|
9305
9340
|
/**
|
|
9306
9341
|
* Gets submission as document which may include the document download url if the document is ready.
|
|
9307
9342
|
* @param submissionId - Submission ID.
|
|
@@ -9312,7 +9347,7 @@ declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promi
|
|
|
9312
9347
|
* @applicableIdentity APP
|
|
9313
9348
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmissionDownloadUrl
|
|
9314
9349
|
*/
|
|
9315
|
-
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`,
|
|
9350
|
+
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`, 2>>;
|
|
9316
9351
|
/**
|
|
9317
9352
|
* Download a submission document by redirecting to the document URL.
|
|
9318
9353
|
* @param submissionId - Submission id for which the document is generated.
|
|
@@ -9323,7 +9358,7 @@ declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNull
|
|
|
9323
9358
|
* @requiredField submissionId
|
|
9324
9359
|
* @fqn wix.forms.v4.FormSubmissionService.DownloadSubmission
|
|
9325
9360
|
*/
|
|
9326
|
-
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`,
|
|
9361
|
+
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 2>>;
|
|
9327
9362
|
/**
|
|
9328
9363
|
* Retrieves a submission formatted by language
|
|
9329
9364
|
* @param submissionId - Submission ID.
|
|
@@ -9334,7 +9369,7 @@ declare function downloadSubmission(submissionId: string, accessToken: string):
|
|
|
9334
9369
|
* @applicableIdentity APP
|
|
9335
9370
|
* @fqn wix.forms.v4.FormSubmissionService.GetFormattedSubmission
|
|
9336
9371
|
*/
|
|
9337
|
-
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`,
|
|
9372
|
+
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`, 2>>;
|
|
9338
9373
|
/**
|
|
9339
9374
|
* Update Extended Fields of the Form
|
|
9340
9375
|
* @param _id - ID of the entity to update.
|
|
@@ -9349,7 +9384,7 @@ declare function getFormattedSubmission(submissionId: string): Promise<NonNullab
|
|
|
9349
9384
|
* @applicableIdentity APP
|
|
9350
9385
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateExtendedFields
|
|
9351
9386
|
*/
|
|
9352
|
-
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`,
|
|
9387
|
+
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 0>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`, 0>>;
|
|
9353
9388
|
interface UpdateExtendedFieldsOptions {
|
|
9354
9389
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
9355
9390
|
namespaceData: Record<string, any> | null;
|
|
@@ -9364,7 +9399,7 @@ interface UpdateExtendedFieldsOptions {
|
|
|
9364
9399
|
* @applicableIdentity APP
|
|
9365
9400
|
* @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTags
|
|
9366
9401
|
*/
|
|
9367
|
-
declare function bulkUpdateFormSubmissionTags(submissionIds: string[], options?: BulkUpdateFormSubmissionTagsOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
9402
|
+
declare function bulkUpdateFormSubmissionTags(submissionIds: string[], options?: BulkUpdateFormSubmissionTagsOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
9368
9403
|
interface BulkUpdateFormSubmissionTagsOptions {
|
|
9369
9404
|
/** Tags to be added to submissions */
|
|
9370
9405
|
assignTags?: PublicTags;
|
|
@@ -9381,7 +9416,7 @@ interface BulkUpdateFormSubmissionTagsOptions {
|
|
|
9381
9416
|
* @applicableIdentity APP
|
|
9382
9417
|
* @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTagsByFilter
|
|
9383
9418
|
*/
|
|
9384
|
-
declare function bulkUpdateFormSubmissionTagsByFilter(filter: Record<string, any>, options?: BulkUpdateFormSubmissionTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsByFilterResponse, `jobId`,
|
|
9419
|
+
declare function bulkUpdateFormSubmissionTagsByFilter(filter: Record<string, any>, options?: BulkUpdateFormSubmissionTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsByFilterResponse, `jobId`, 0>>;
|
|
9385
9420
|
interface BulkUpdateFormSubmissionTagsByFilterOptions {
|
|
9386
9421
|
/** Tags to be added to submissions */
|
|
9387
9422
|
assignTags?: PublicTags;
|
|
@@ -9398,7 +9433,7 @@ interface BulkUpdateFormSubmissionTagsByFilterOptions {
|
|
|
9398
9433
|
* @applicableIdentity APP
|
|
9399
9434
|
* @fqn wix.forms.v4.FormSubmissionService.ValidateFormSubmission
|
|
9400
9435
|
*/
|
|
9401
|
-
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`,
|
|
9436
|
+
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`, 2>>;
|
|
9402
9437
|
interface ValidateFormSubmissionOptions {
|
|
9403
9438
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
9404
9439
|
additionalMetadata?: Record<string, any> | null;
|