@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. */
|
|
@@ -726,9 +734,11 @@ interface Form {
|
|
|
726
734
|
extendedFields?: ExtendedFields;
|
|
727
735
|
/**
|
|
728
736
|
* Unique identifier for the app that owns this form schema.
|
|
729
|
-
*
|
|
737
|
+
*
|
|
738
|
+
* 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`.
|
|
730
739
|
*
|
|
731
740
|
* 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.
|
|
741
|
+
* 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).
|
|
732
742
|
* @minLength 10
|
|
733
743
|
* @maxLength 50
|
|
734
744
|
* @immutable
|
|
@@ -1402,7 +1412,7 @@ interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
1402
1412
|
* Identification for the field, describing its purpose. For example, `TEXT_INPUT` or `CONTACTS_EMAIL`.
|
|
1403
1413
|
*
|
|
1404
1414
|
* Set this to the known value for the kind of field you're creating.
|
|
1405
|
-
*
|
|
1415
|
+
* 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.
|
|
1406
1416
|
*
|
|
1407
1417
|
* Several fields share a general-purpose `componentType`, so `identifier` is often the only value that distinguishes them.
|
|
1408
1418
|
* 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.
|
|
@@ -1496,6 +1506,8 @@ interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
1496
1506
|
/**
|
|
1497
1507
|
* Whether the field is required for form submission.
|
|
1498
1508
|
*
|
|
1509
|
+
* 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.
|
|
1510
|
+
*
|
|
1499
1511
|
* Default: `false`
|
|
1500
1512
|
*/
|
|
1501
1513
|
required?: boolean;
|
|
@@ -6825,6 +6837,9 @@ interface Rule {
|
|
|
6825
6837
|
/**
|
|
6826
6838
|
* Conditional expression that determines when this rule should be applied.
|
|
6827
6839
|
* The overrides defined in this rule are applied when this expression evaluates to true.
|
|
6840
|
+
*
|
|
6841
|
+
* The root of the expression must be an `and` or `or` group. To evaluate a
|
|
6842
|
+
* single condition, wrap it in a group with 1 condition.
|
|
6828
6843
|
*/
|
|
6829
6844
|
expression?: ConditionNode;
|
|
6830
6845
|
/**
|
|
@@ -6900,12 +6915,19 @@ interface FieldOverridePropertyTypeOptionsOneOf {
|
|
|
6900
6915
|
/** Configuration for changing the allowed values of a field. */
|
|
6901
6916
|
allowedValuesOptions?: AllowedValuesOptions;
|
|
6902
6917
|
}
|
|
6918
|
+
/**
|
|
6919
|
+
* Node of a rule's conditional expression. Either a logical group of nested
|
|
6920
|
+
* nodes, or a single condition.
|
|
6921
|
+
*
|
|
6922
|
+
* The root node of a rule's expression must be an `and` or `or` group.
|
|
6923
|
+
* A single condition is only supported in nested nodes.
|
|
6924
|
+
*/
|
|
6903
6925
|
interface ConditionNode extends ConditionNodeNodeOneOf {
|
|
6904
6926
|
/** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
|
|
6905
6927
|
and?: AndCondition;
|
|
6906
6928
|
/** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
|
|
6907
6929
|
or?: OrCondition;
|
|
6908
|
-
/** Single condition to evaluate. */
|
|
6930
|
+
/** Single condition to evaluate. Not supported as the root of a rule's expression. */
|
|
6909
6931
|
condition?: Condition;
|
|
6910
6932
|
}
|
|
6911
6933
|
/** @oneof */
|
|
@@ -6914,7 +6936,7 @@ interface ConditionNodeNodeOneOf {
|
|
|
6914
6936
|
and?: AndCondition;
|
|
6915
6937
|
/** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
|
|
6916
6938
|
or?: OrCondition;
|
|
6917
|
-
/** Single condition to evaluate. */
|
|
6939
|
+
/** Single condition to evaluate. Not supported as the root of a rule's expression. */
|
|
6918
6940
|
condition?: Condition;
|
|
6919
6941
|
}
|
|
6920
6942
|
interface AndCondition {
|
|
@@ -8387,7 +8409,7 @@ declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEnvelope)
|
|
|
8387
8409
|
* @applicableIdentity APP
|
|
8388
8410
|
* @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
|
|
8389
8411
|
*/
|
|
8390
|
-
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`,
|
|
8412
|
+
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`, 1>>;
|
|
8391
8413
|
interface UpsertContactFromSubmissionOptions {
|
|
8392
8414
|
/**
|
|
8393
8415
|
* Optional contact id to which submission should be mapped.
|
|
@@ -8412,7 +8434,7 @@ interface UpsertContactFromSubmissionOptions {
|
|
|
8412
8434
|
* @returns The created submission.
|
|
8413
8435
|
* @fqn wix.forms.v4.FormSubmissionService.CreateSubmission
|
|
8414
8436
|
*/
|
|
8415
|
-
declare function createSubmission(submission: NonNullablePaths<FormSubmission, `formId`,
|
|
8437
|
+
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> & {
|
|
8416
8438
|
__applicationErrorsType?: CreateSubmissionApplicationErrors;
|
|
8417
8439
|
__validationErrorsType?: CreateSubmissionValidationErrors;
|
|
8418
8440
|
}>;
|
|
@@ -8436,7 +8458,7 @@ interface CreateSubmissionOptions {
|
|
|
8436
8458
|
* @returns The retrieved submission.
|
|
8437
8459
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmission
|
|
8438
8460
|
*/
|
|
8439
|
-
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`,
|
|
8461
|
+
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`, 2>>;
|
|
8440
8462
|
/**
|
|
8441
8463
|
* Updates a submission.
|
|
8442
8464
|
*
|
|
@@ -8454,7 +8476,7 @@ declare function getSubmission(submissionId: string): Promise<NonNullablePaths<F
|
|
|
8454
8476
|
* @returns The updated submission.
|
|
8455
8477
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateSubmission
|
|
8456
8478
|
*/
|
|
8457
|
-
declare function updateSubmission(_id: string, submission: NonNullablePaths<UpdateSubmission, `formId` | `revision`,
|
|
8479
|
+
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> & {
|
|
8458
8480
|
__validationErrorsType?: UpdateSubmissionValidationErrors;
|
|
8459
8481
|
}>;
|
|
8460
8482
|
interface UpdateSubmission {
|
|
@@ -8552,6 +8574,14 @@ interface UpdateSubmission {
|
|
|
8552
8574
|
* This object is only applicable when submitting a form that creates a booking appointment.
|
|
8553
8575
|
*/
|
|
8554
8576
|
appointmentDetails?: AppointmentDetails;
|
|
8577
|
+
/**
|
|
8578
|
+
* ID of the child site the submission was made on.
|
|
8579
|
+
*
|
|
8580
|
+
* 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.
|
|
8581
|
+
* @format GUID
|
|
8582
|
+
* @readonly
|
|
8583
|
+
*/
|
|
8584
|
+
childMetaSiteId?: string | null;
|
|
8555
8585
|
}
|
|
8556
8586
|
/**
|
|
8557
8587
|
* Confirms a submission.
|
|
@@ -8567,7 +8597,7 @@ interface UpdateSubmission {
|
|
|
8567
8597
|
* @applicableIdentity APP
|
|
8568
8598
|
* @fqn wix.forms.v4.FormSubmissionService.ConfirmSubmission
|
|
8569
8599
|
*/
|
|
8570
|
-
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`,
|
|
8600
|
+
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>>;
|
|
8571
8601
|
/**
|
|
8572
8602
|
* Deletes a submission.
|
|
8573
8603
|
*
|
|
@@ -8603,7 +8633,7 @@ interface DeleteSubmissionOptions {
|
|
|
8603
8633
|
* @applicableIdentity APP
|
|
8604
8634
|
* @fqn wix.forms.v4.FormSubmissionService.BulkDeleteSubmission
|
|
8605
8635
|
*/
|
|
8606
|
-
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`,
|
|
8636
|
+
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>>;
|
|
8607
8637
|
interface BulkDeleteSubmissionOptions {
|
|
8608
8638
|
/**
|
|
8609
8639
|
* Submission ids.
|
|
@@ -8630,7 +8660,7 @@ interface BulkDeleteSubmissionOptions {
|
|
|
8630
8660
|
* @applicableIdentity APP
|
|
8631
8661
|
* @fqn wix.forms.v4.FormSubmissionService.RestoreSubmissionFromTrashBin
|
|
8632
8662
|
*/
|
|
8633
|
-
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`,
|
|
8663
|
+
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>>;
|
|
8634
8664
|
/**
|
|
8635
8665
|
* Remove deleted submission
|
|
8636
8666
|
* @param submissionId - ID of the submission to restore.
|
|
@@ -8652,7 +8682,7 @@ declare function removeSubmissionFromTrashBin(submissionId: string): Promise<voi
|
|
|
8652
8682
|
* @applicableIdentity APP
|
|
8653
8683
|
* @fqn wix.forms.v4.FormSubmissionService.BulkRemoveSubmissionFromTrashBin
|
|
8654
8684
|
*/
|
|
8655
|
-
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`,
|
|
8685
|
+
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>>;
|
|
8656
8686
|
interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
8657
8687
|
/**
|
|
8658
8688
|
* Submission ids.
|
|
@@ -8672,7 +8702,7 @@ interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
|
8672
8702
|
* @applicableIdentity APP
|
|
8673
8703
|
* @fqn wix.forms.v4.FormSubmissionService.ListDeletedSubmissions
|
|
8674
8704
|
*/
|
|
8675
|
-
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`,
|
|
8705
|
+
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>>;
|
|
8676
8706
|
interface ListDeletedSubmissionsOptions {
|
|
8677
8707
|
/**
|
|
8678
8708
|
* Submission ids.
|
|
@@ -8699,7 +8729,7 @@ interface ListDeletedSubmissionsOptions {
|
|
|
8699
8729
|
* @applicableIdentity APP
|
|
8700
8730
|
* @fqn wix.forms.v4.FormSubmissionService.GetDeletedSubmission
|
|
8701
8731
|
*/
|
|
8702
|
-
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`,
|
|
8732
|
+
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>>;
|
|
8703
8733
|
/**
|
|
8704
8734
|
* Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace.
|
|
8705
8735
|
* @param query - Query options.
|
|
@@ -8713,7 +8743,7 @@ declare function getDeletedSubmission(submissionId: string): Promise<NonNullable
|
|
|
8713
8743
|
* @replacedBy com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
8714
8744
|
* @targetRemovalDate 2025-04-01
|
|
8715
8745
|
*/
|
|
8716
|
-
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`,
|
|
8746
|
+
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>>;
|
|
8717
8747
|
interface QuerySubmissionOptions {
|
|
8718
8748
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
8719
8749
|
onlyYourOwn?: boolean;
|
|
@@ -8852,11 +8882,11 @@ interface SubmissionsQueryBuilder {
|
|
|
8852
8882
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
8853
8883
|
* @param value - Value to compare against.
|
|
8854
8884
|
*/
|
|
8855
|
-
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
8885
|
+
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
8856
8886
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
8857
8887
|
* @param value - Value to compare against.
|
|
8858
8888
|
*/
|
|
8859
|
-
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
8889
|
+
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
8860
8890
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
8861
8891
|
* @param value - Value to compare against.
|
|
8862
8892
|
*/
|
|
@@ -8873,7 +8903,7 @@ interface SubmissionsQueryBuilder {
|
|
|
8873
8903
|
* @param value - Value to compare against.
|
|
8874
8904
|
*/
|
|
8875
8905
|
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
|
|
8876
|
-
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
8906
|
+
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
8877
8907
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
8878
8908
|
ascending: (...propertyNames: Array<'_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId'>) => SubmissionsQueryBuilder;
|
|
8879
8909
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -8889,7 +8919,7 @@ interface SubmissionsQueryBuilder {
|
|
|
8889
8919
|
* @fqn wix.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
8890
8920
|
* @requiredField query
|
|
8891
8921
|
*/
|
|
8892
|
-
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`,
|
|
8922
|
+
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>>;
|
|
8893
8923
|
interface FormSubmissionQuerySpec extends QuerySpec {
|
|
8894
8924
|
paging: 'cursor';
|
|
8895
8925
|
wql: [
|
|
@@ -8942,6 +8972,11 @@ interface FormSubmissionQuerySpec extends QuerySpec {
|
|
|
8942
8972
|
fields: ['orderDetails.checkoutId'];
|
|
8943
8973
|
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
8944
8974
|
sort: 'BOTH';
|
|
8975
|
+
},
|
|
8976
|
+
{
|
|
8977
|
+
fields: ['childMetaSiteId'];
|
|
8978
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
8979
|
+
sort: 'NONE';
|
|
8945
8980
|
}
|
|
8946
8981
|
];
|
|
8947
8982
|
}
|
|
@@ -9004,7 +9039,7 @@ type FormSubmissionQuery = {
|
|
|
9004
9039
|
* @applicableIdentity APP
|
|
9005
9040
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissionsByFilter
|
|
9006
9041
|
*/
|
|
9007
|
-
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9042
|
+
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9008
9043
|
interface CountSubmissionsByFilterOptions {
|
|
9009
9044
|
/** Free text to match in searchable fields. */
|
|
9010
9045
|
search?: SearchDetails;
|
|
@@ -9023,7 +9058,7 @@ interface CountSubmissionsByFilterOptions {
|
|
|
9023
9058
|
* @applicableIdentity APP
|
|
9024
9059
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissions
|
|
9025
9060
|
*/
|
|
9026
|
-
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9061
|
+
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9027
9062
|
interface CountSubmissionsOptions {
|
|
9028
9063
|
/**
|
|
9029
9064
|
* Status of the submission.
|
|
@@ -9050,7 +9085,7 @@ interface CountSubmissionsOptions {
|
|
|
9050
9085
|
* @applicableIdentity APP
|
|
9051
9086
|
* @fqn wix.forms.v4.FormSubmissionService.CountDeletedSubmissions
|
|
9052
9087
|
*/
|
|
9053
|
-
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`,
|
|
9088
|
+
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`, 2>>;
|
|
9054
9089
|
interface CountDeletedSubmissionsOptions {
|
|
9055
9090
|
/**
|
|
9056
9091
|
* List of statuses of submissions which should be taken into count
|
|
@@ -9078,7 +9113,7 @@ interface CountDeletedSubmissionsOptions {
|
|
|
9078
9113
|
* @applicableIdentity APP
|
|
9079
9114
|
* @fqn wix.forms.v4.FormSubmissionService.GetMediaUploadURL
|
|
9080
9115
|
*/
|
|
9081
|
-
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`,
|
|
9116
|
+
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`, 0>>;
|
|
9082
9117
|
/**
|
|
9083
9118
|
* Marks form submissions as "seen".
|
|
9084
9119
|
*
|
|
@@ -9093,7 +9128,7 @@ declare function getMediaUploadUrl(formId: string, filename: string, mimeType: s
|
|
|
9093
9128
|
* @applicableIdentity APP
|
|
9094
9129
|
* @fqn wix.forms.v4.FormSubmissionService.BulkMarkSubmissionsAsSeen
|
|
9095
9130
|
*/
|
|
9096
|
-
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`,
|
|
9131
|
+
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`, 0>>;
|
|
9097
9132
|
/**
|
|
9098
9133
|
* Gets submission as document which may include the document download url if the document is ready.
|
|
9099
9134
|
* @param submissionId - Submission ID.
|
|
@@ -9104,7 +9139,7 @@ declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promi
|
|
|
9104
9139
|
* @applicableIdentity APP
|
|
9105
9140
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmissionDownloadUrl
|
|
9106
9141
|
*/
|
|
9107
|
-
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`,
|
|
9142
|
+
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`, 2>>;
|
|
9108
9143
|
/**
|
|
9109
9144
|
* Download a submission document by redirecting to the document URL.
|
|
9110
9145
|
* @param submissionId - Submission id for which the document is generated.
|
|
@@ -9115,7 +9150,7 @@ declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNull
|
|
|
9115
9150
|
* @requiredField submissionId
|
|
9116
9151
|
* @fqn wix.forms.v4.FormSubmissionService.DownloadSubmission
|
|
9117
9152
|
*/
|
|
9118
|
-
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`,
|
|
9153
|
+
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 2>>;
|
|
9119
9154
|
/**
|
|
9120
9155
|
* Retrieves a submission formatted by language
|
|
9121
9156
|
* @param submissionId - Submission ID.
|
|
@@ -9126,7 +9161,7 @@ declare function downloadSubmission(submissionId: string, accessToken: string):
|
|
|
9126
9161
|
* @applicableIdentity APP
|
|
9127
9162
|
* @fqn wix.forms.v4.FormSubmissionService.GetFormattedSubmission
|
|
9128
9163
|
*/
|
|
9129
|
-
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`,
|
|
9164
|
+
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`, 2>>;
|
|
9130
9165
|
/**
|
|
9131
9166
|
* Update Extended Fields of the Form
|
|
9132
9167
|
* @param _id - ID of the entity to update.
|
|
@@ -9141,7 +9176,7 @@ declare function getFormattedSubmission(submissionId: string): Promise<NonNullab
|
|
|
9141
9176
|
* @applicableIdentity APP
|
|
9142
9177
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateExtendedFields
|
|
9143
9178
|
*/
|
|
9144
|
-
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`,
|
|
9179
|
+
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 0>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`, 0>>;
|
|
9145
9180
|
interface UpdateExtendedFieldsOptions {
|
|
9146
9181
|
/** 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. */
|
|
9147
9182
|
namespaceData: Record<string, any> | null;
|
|
@@ -9168,7 +9203,7 @@ interface BulkUpdateFormSubmissionTagsByFilterOptions {
|
|
|
9168
9203
|
* @applicableIdentity APP
|
|
9169
9204
|
* @fqn wix.forms.v4.FormSubmissionService.ValidateFormSubmission
|
|
9170
9205
|
*/
|
|
9171
|
-
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`,
|
|
9206
|
+
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`, 2>>;
|
|
9172
9207
|
interface ValidateFormSubmissionOptions {
|
|
9173
9208
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
9174
9209
|
additionalMetadata?: Record<string, any> | null;
|