@wix/auto_sdk_forms_submissions 1.0.157 → 1.0.159
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-C6InzFwD.d.ts → forms-v4-submission-submissions.universal-BC0DUgQ1.d.ts} +48 -25
- 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 +11 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{forms-v4-submission-submissions.universal-C6InzFwD.d.mts → forms-v4-submission-submissions.universal-BC0DUgQ1.d.mts} +48 -25
- 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 +11 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{forms-v4-submission-submissions.universal-DUQkvNPc.d.ts → forms-v4-submission-submissions.universal-BzLudywA.d.ts} +50 -27
- 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 +11 -1
- package/build/internal/es/{forms-v4-submission-submissions.universal-DUQkvNPc.d.mts → forms-v4-submission-submissions.universal-BzLudywA.d.mts} +50 -27
- 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 +11 -1
- 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. */
|
|
@@ -871,6 +879,7 @@ interface Form {
|
|
|
871
879
|
interface FormField {
|
|
872
880
|
/**
|
|
873
881
|
* Item ID.
|
|
882
|
+
* @minLength 1
|
|
874
883
|
* @format GUID
|
|
875
884
|
* @immutable
|
|
876
885
|
*/
|
|
@@ -1467,6 +1476,7 @@ interface Field extends FieldFieldTypeOptionsOneOf {
|
|
|
1467
1476
|
* Field ID.
|
|
1468
1477
|
*
|
|
1469
1478
|
* 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.
|
|
1479
|
+
* @minLength 1
|
|
1470
1480
|
* @format GUID
|
|
1471
1481
|
* @immutable
|
|
1472
1482
|
*/
|
|
@@ -8604,7 +8614,7 @@ declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEnvelope)
|
|
|
8604
8614
|
* @applicableIdentity APP
|
|
8605
8615
|
* @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
|
|
8606
8616
|
*/
|
|
8607
|
-
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`,
|
|
8617
|
+
declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<NonNullablePaths<UpsertContactFromSubmissionResponse, `submitContactResponse.contactId` | `submitContactResponse.identityType` | `submitContactResponse.newContact`, 1>>;
|
|
8608
8618
|
interface UpsertContactFromSubmissionOptions {
|
|
8609
8619
|
/**
|
|
8610
8620
|
* Optional contact id to which submission should be mapped.
|
|
@@ -8629,7 +8639,7 @@ interface UpsertContactFromSubmissionOptions {
|
|
|
8629
8639
|
* @returns The created submission.
|
|
8630
8640
|
* @fqn wix.forms.v4.FormSubmissionService.CreateSubmission
|
|
8631
8641
|
*/
|
|
8632
|
-
declare function createSubmission(submission: NonNullablePaths<FormSubmission, `formId`,
|
|
8642
|
+
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> & {
|
|
8633
8643
|
__applicationErrorsType?: CreateSubmissionApplicationErrors;
|
|
8634
8644
|
__validationErrorsType?: CreateSubmissionValidationErrors;
|
|
8635
8645
|
}>;
|
|
@@ -8653,7 +8663,7 @@ interface CreateSubmissionOptions {
|
|
|
8653
8663
|
* @returns The retrieved submission.
|
|
8654
8664
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmission
|
|
8655
8665
|
*/
|
|
8656
|
-
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`,
|
|
8666
|
+
declare function getSubmission(submissionId: string): Promise<NonNullablePaths<FormSubmission, `formId` | `namespace` | `status` | `seen` | `orderDetails.itemSubtotal` | `orderDetails.checkoutId` | `tags.tags.tagIds`, 2>>;
|
|
8657
8667
|
/**
|
|
8658
8668
|
* Updates a submission.
|
|
8659
8669
|
*
|
|
@@ -8671,7 +8681,7 @@ declare function getSubmission(submissionId: string): Promise<NonNullablePaths<F
|
|
|
8671
8681
|
* @returns The updated submission.
|
|
8672
8682
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateSubmission
|
|
8673
8683
|
*/
|
|
8674
|
-
declare function updateSubmission(_id: string, submission: NonNullablePaths<UpdateSubmission, `formId` | `revision`,
|
|
8684
|
+
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> & {
|
|
8675
8685
|
__validationErrorsType?: UpdateSubmissionValidationErrors;
|
|
8676
8686
|
}>;
|
|
8677
8687
|
interface UpdateSubmission {
|
|
@@ -8769,6 +8779,14 @@ interface UpdateSubmission {
|
|
|
8769
8779
|
* This object is only applicable when submitting a form that creates a booking appointment.
|
|
8770
8780
|
*/
|
|
8771
8781
|
appointmentDetails?: AppointmentDetails;
|
|
8782
|
+
/**
|
|
8783
|
+
* ID of the child site the submission was made on.
|
|
8784
|
+
*
|
|
8785
|
+
* 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.
|
|
8786
|
+
* @format GUID
|
|
8787
|
+
* @readonly
|
|
8788
|
+
*/
|
|
8789
|
+
childMetaSiteId?: string | null;
|
|
8772
8790
|
}
|
|
8773
8791
|
/**
|
|
8774
8792
|
* Confirms a submission.
|
|
@@ -8784,7 +8802,7 @@ interface UpdateSubmission {
|
|
|
8784
8802
|
* @applicableIdentity APP
|
|
8785
8803
|
* @fqn wix.forms.v4.FormSubmissionService.ConfirmSubmission
|
|
8786
8804
|
*/
|
|
8787
|
-
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`,
|
|
8805
|
+
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>>;
|
|
8788
8806
|
/**
|
|
8789
8807
|
* Deletes a submission.
|
|
8790
8808
|
*
|
|
@@ -8820,7 +8838,7 @@ interface DeleteSubmissionOptions {
|
|
|
8820
8838
|
* @applicableIdentity APP
|
|
8821
8839
|
* @fqn wix.forms.v4.FormSubmissionService.BulkDeleteSubmission
|
|
8822
8840
|
*/
|
|
8823
|
-
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`,
|
|
8841
|
+
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>>;
|
|
8824
8842
|
interface BulkDeleteSubmissionOptions {
|
|
8825
8843
|
/**
|
|
8826
8844
|
* Submission ids.
|
|
@@ -8847,7 +8865,7 @@ interface BulkDeleteSubmissionOptions {
|
|
|
8847
8865
|
* @applicableIdentity APP
|
|
8848
8866
|
* @fqn wix.forms.v4.FormSubmissionService.RestoreSubmissionFromTrashBin
|
|
8849
8867
|
*/
|
|
8850
|
-
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`,
|
|
8868
|
+
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>>;
|
|
8851
8869
|
/**
|
|
8852
8870
|
* Remove deleted submission
|
|
8853
8871
|
* @param submissionId - ID of the submission to restore.
|
|
@@ -8869,7 +8887,7 @@ declare function removeSubmissionFromTrashBin(submissionId: string): Promise<voi
|
|
|
8869
8887
|
* @applicableIdentity APP
|
|
8870
8888
|
* @fqn wix.forms.v4.FormSubmissionService.BulkRemoveSubmissionFromTrashBin
|
|
8871
8889
|
*/
|
|
8872
|
-
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`,
|
|
8890
|
+
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>>;
|
|
8873
8891
|
interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
8874
8892
|
/**
|
|
8875
8893
|
* Submission ids.
|
|
@@ -8889,7 +8907,7 @@ interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
|
8889
8907
|
* @applicableIdentity APP
|
|
8890
8908
|
* @fqn wix.forms.v4.FormSubmissionService.ListDeletedSubmissions
|
|
8891
8909
|
*/
|
|
8892
|
-
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`,
|
|
8910
|
+
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>>;
|
|
8893
8911
|
interface ListDeletedSubmissionsOptions {
|
|
8894
8912
|
/**
|
|
8895
8913
|
* Submission ids.
|
|
@@ -8916,7 +8934,7 @@ interface ListDeletedSubmissionsOptions {
|
|
|
8916
8934
|
* @applicableIdentity APP
|
|
8917
8935
|
* @fqn wix.forms.v4.FormSubmissionService.GetDeletedSubmission
|
|
8918
8936
|
*/
|
|
8919
|
-
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`,
|
|
8937
|
+
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>>;
|
|
8920
8938
|
/**
|
|
8921
8939
|
* Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace.
|
|
8922
8940
|
* @param query - Query options.
|
|
@@ -8930,7 +8948,7 @@ declare function getDeletedSubmission(submissionId: string): Promise<NonNullable
|
|
|
8930
8948
|
* @replacedBy com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
8931
8949
|
* @targetRemovalDate 2025-04-01
|
|
8932
8950
|
*/
|
|
8933
|
-
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`,
|
|
8951
|
+
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>>;
|
|
8934
8952
|
interface QuerySubmissionOptions {
|
|
8935
8953
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
8936
8954
|
onlyYourOwn?: boolean;
|
|
@@ -9074,11 +9092,11 @@ interface SubmissionsQueryBuilder {
|
|
|
9074
9092
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9075
9093
|
* @param value - Value to compare against.
|
|
9076
9094
|
*/
|
|
9077
|
-
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9095
|
+
eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9078
9096
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9079
9097
|
* @param value - Value to compare against.
|
|
9080
9098
|
*/
|
|
9081
|
-
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9099
|
+
ne: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9082
9100
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
9083
9101
|
* @param value - Value to compare against.
|
|
9084
9102
|
*/
|
|
@@ -9095,7 +9113,7 @@ interface SubmissionsQueryBuilder {
|
|
|
9095
9113
|
* @param value - Value to compare against.
|
|
9096
9114
|
*/
|
|
9097
9115
|
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
|
|
9098
|
-
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId', value: any) => SubmissionsQueryBuilder;
|
|
9116
|
+
in: (propertyName: '_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'orderDetails.checkoutId' | 'contactId' | 'childMetaSiteId', value: any) => SubmissionsQueryBuilder;
|
|
9099
9117
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
9100
9118
|
ascending: (...propertyNames: Array<'_id' | 'formId' | 'status' | '_createdDate' | '_updatedDate' | 'submitter.memberId' | 'submitter.visitorId' | 'submitter.applicationId' | 'submitter.userId' | 'seen' | 'orderDetails.checkoutId' | 'contactId'>) => SubmissionsQueryBuilder;
|
|
9101
9119
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -9111,7 +9129,7 @@ interface SubmissionsQueryBuilder {
|
|
|
9111
9129
|
* @fqn wix.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
|
|
9112
9130
|
* @requiredField query
|
|
9113
9131
|
*/
|
|
9114
|
-
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`,
|
|
9132
|
+
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>>;
|
|
9115
9133
|
interface FormSubmissionQuerySpec extends QuerySpec {
|
|
9116
9134
|
paging: 'cursor';
|
|
9117
9135
|
wql: [
|
|
@@ -9164,6 +9182,11 @@ interface FormSubmissionQuerySpec extends QuerySpec {
|
|
|
9164
9182
|
fields: ['orderDetails.checkoutId'];
|
|
9165
9183
|
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
9166
9184
|
sort: 'BOTH';
|
|
9185
|
+
},
|
|
9186
|
+
{
|
|
9187
|
+
fields: ['childMetaSiteId'];
|
|
9188
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
9189
|
+
sort: 'NONE';
|
|
9167
9190
|
}
|
|
9168
9191
|
];
|
|
9169
9192
|
}
|
|
@@ -9226,7 +9249,7 @@ type FormSubmissionQuery = {
|
|
|
9226
9249
|
* @applicableIdentity APP
|
|
9227
9250
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissionsByFilter
|
|
9228
9251
|
*/
|
|
9229
|
-
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9252
|
+
declare function countSubmissionsByFilter(filter: Record<string, any>, options?: CountSubmissionsByFilterOptions): Promise<NonNullablePaths<CountSubmissionsByFilterResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9230
9253
|
interface CountSubmissionsByFilterOptions {
|
|
9231
9254
|
/** Free text to match in searchable fields. */
|
|
9232
9255
|
search?: SearchDetails;
|
|
@@ -9245,7 +9268,7 @@ interface CountSubmissionsByFilterOptions {
|
|
|
9245
9268
|
* @applicableIdentity APP
|
|
9246
9269
|
* @fqn wix.forms.v4.FormSubmissionService.CountSubmissions
|
|
9247
9270
|
*/
|
|
9248
|
-
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`,
|
|
9271
|
+
declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<NonNullablePaths<CountSubmissionsResponse, `formsSubmissionsCount` | `formsSubmissionsCount.${number}.formId` | `formsSubmissionsCount.${number}.totalCount` | `formsSubmissionsCount.${number}.unseenCount`, 2>>;
|
|
9249
9272
|
interface CountSubmissionsOptions {
|
|
9250
9273
|
/**
|
|
9251
9274
|
* Status of the submission.
|
|
@@ -9272,7 +9295,7 @@ interface CountSubmissionsOptions {
|
|
|
9272
9295
|
* @applicableIdentity APP
|
|
9273
9296
|
* @fqn wix.forms.v4.FormSubmissionService.CountDeletedSubmissions
|
|
9274
9297
|
*/
|
|
9275
|
-
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`,
|
|
9298
|
+
declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<NonNullablePaths<CountDeletedSubmissionsResponse, `formsDeletedSubmissionsCount` | `formsDeletedSubmissionsCount.${number}.formId` | `formsDeletedSubmissionsCount.${number}.totalCount`, 2>>;
|
|
9276
9299
|
interface CountDeletedSubmissionsOptions {
|
|
9277
9300
|
/**
|
|
9278
9301
|
* List of statuses of submissions which should be taken into count
|
|
@@ -9300,7 +9323,7 @@ interface CountDeletedSubmissionsOptions {
|
|
|
9300
9323
|
* @applicableIdentity APP
|
|
9301
9324
|
* @fqn wix.forms.v4.FormSubmissionService.GetMediaUploadURL
|
|
9302
9325
|
*/
|
|
9303
|
-
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`,
|
|
9326
|
+
declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<NonNullablePaths<GetMediaUploadURLResponse, `uploadUrl`, 0>>;
|
|
9304
9327
|
/**
|
|
9305
9328
|
* Marks form submissions as "seen".
|
|
9306
9329
|
*
|
|
@@ -9315,7 +9338,7 @@ declare function getMediaUploadUrl(formId: string, filename: string, mimeType: s
|
|
|
9315
9338
|
* @applicableIdentity APP
|
|
9316
9339
|
* @fqn wix.forms.v4.FormSubmissionService.BulkMarkSubmissionsAsSeen
|
|
9317
9340
|
*/
|
|
9318
|
-
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`,
|
|
9341
|
+
declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<NonNullablePaths<BulkMarkSubmissionsAsSeenResponse, `jobId`, 0>>;
|
|
9319
9342
|
/**
|
|
9320
9343
|
* Gets submission as document which may include the document download url if the document is ready.
|
|
9321
9344
|
* @param submissionId - Submission ID.
|
|
@@ -9326,7 +9349,7 @@ declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promi
|
|
|
9326
9349
|
* @applicableIdentity APP
|
|
9327
9350
|
* @fqn wix.forms.v4.FormSubmissionService.GetSubmissionDownloadUrl
|
|
9328
9351
|
*/
|
|
9329
|
-
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`,
|
|
9352
|
+
declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNullablePaths<GetSubmissionDownloadUrlResponse, `document.readyDetails.downloadUrl` | `document.status`, 2>>;
|
|
9330
9353
|
/**
|
|
9331
9354
|
* Download a submission document by redirecting to the document URL.
|
|
9332
9355
|
* @param submissionId - Submission id for which the document is generated.
|
|
@@ -9337,7 +9360,7 @@ declare function getSubmissionDownloadUrl(submissionId: string): Promise<NonNull
|
|
|
9337
9360
|
* @requiredField submissionId
|
|
9338
9361
|
* @fqn wix.forms.v4.FormSubmissionService.DownloadSubmission
|
|
9339
9362
|
*/
|
|
9340
|
-
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`,
|
|
9363
|
+
declare function downloadSubmission(submissionId: string, accessToken: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 2>>;
|
|
9341
9364
|
/**
|
|
9342
9365
|
* Retrieves a submission formatted by language
|
|
9343
9366
|
* @param submissionId - Submission ID.
|
|
@@ -9348,7 +9371,7 @@ declare function downloadSubmission(submissionId: string, accessToken: string):
|
|
|
9348
9371
|
* @applicableIdentity APP
|
|
9349
9372
|
* @fqn wix.forms.v4.FormSubmissionService.GetFormattedSubmission
|
|
9350
9373
|
*/
|
|
9351
|
-
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`,
|
|
9374
|
+
declare function getFormattedSubmission(submissionId: string): Promise<NonNullablePaths<GetFormattedSubmissionResponse, `submissionId` | `submissions` | `submissions.${number}.key` | `submissions.${number}.value` | `submissions.${number}.fieldId`, 2>>;
|
|
9352
9375
|
/**
|
|
9353
9376
|
* Update Extended Fields of the Form
|
|
9354
9377
|
* @param _id - ID of the entity to update.
|
|
@@ -9363,7 +9386,7 @@ declare function getFormattedSubmission(submissionId: string): Promise<NonNullab
|
|
|
9363
9386
|
* @applicableIdentity APP
|
|
9364
9387
|
* @fqn wix.forms.v4.FormSubmissionService.UpdateExtendedFields
|
|
9365
9388
|
*/
|
|
9366
|
-
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`,
|
|
9389
|
+
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 0>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`, 0>>;
|
|
9367
9390
|
interface UpdateExtendedFieldsOptions {
|
|
9368
9391
|
/** 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. */
|
|
9369
9392
|
namespaceData: Record<string, any> | null;
|
|
@@ -9378,7 +9401,7 @@ interface UpdateExtendedFieldsOptions {
|
|
|
9378
9401
|
* @applicableIdentity APP
|
|
9379
9402
|
* @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTags
|
|
9380
9403
|
*/
|
|
9381
|
-
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`,
|
|
9404
|
+
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>>;
|
|
9382
9405
|
interface BulkUpdateFormSubmissionTagsOptions {
|
|
9383
9406
|
/** Tags to be added to submissions */
|
|
9384
9407
|
assignTags?: PublicTags;
|
|
@@ -9395,7 +9418,7 @@ interface BulkUpdateFormSubmissionTagsOptions {
|
|
|
9395
9418
|
* @applicableIdentity APP
|
|
9396
9419
|
* @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTagsByFilter
|
|
9397
9420
|
*/
|
|
9398
|
-
declare function bulkUpdateFormSubmissionTagsByFilter(filter: Record<string, any>, options?: BulkUpdateFormSubmissionTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsByFilterResponse, `jobId`,
|
|
9421
|
+
declare function bulkUpdateFormSubmissionTagsByFilter(filter: Record<string, any>, options?: BulkUpdateFormSubmissionTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateFormSubmissionTagsByFilterResponse, `jobId`, 0>>;
|
|
9399
9422
|
interface BulkUpdateFormSubmissionTagsByFilterOptions {
|
|
9400
9423
|
/** Tags to be added to submissions */
|
|
9401
9424
|
assignTags?: PublicTags;
|
|
@@ -9412,7 +9435,7 @@ interface BulkUpdateFormSubmissionTagsByFilterOptions {
|
|
|
9412
9435
|
* @applicableIdentity APP
|
|
9413
9436
|
* @fqn wix.forms.v4.FormSubmissionService.ValidateFormSubmission
|
|
9414
9437
|
*/
|
|
9415
|
-
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`,
|
|
9438
|
+
declare function validateFormSubmission(submission: FormSubmission, options?: ValidateFormSubmissionOptions): Promise<NonNullablePaths<ValidateFormSubmissionResponse, `violationErrors` | `violationErrors.${number}.name` | `violationErrors.${number}.description` | `violationErrors.${number}.ruleName`, 2>>;
|
|
9416
9439
|
interface ValidateFormSubmissionOptions {
|
|
9417
9440
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
9418
9441
|
additionalMetadata?: Record<string, any> | null;
|