@wix/forms 1.0.12 → 1.0.14
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/src/forms-v4-submission.http.d.ts +6 -8
- package/build/cjs/src/forms-v4-submission.http.js +16 -20
- package/build/cjs/src/forms-v4-submission.http.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.public.d.ts +3 -3
- package/build/cjs/src/forms-v4-submission.public.js +4 -4
- package/build/cjs/src/forms-v4-submission.public.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.types.d.ts +34 -23
- package/build/cjs/src/forms-v4-submission.types.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.universal.d.ts +70 -39
- package/build/cjs/src/forms-v4-submission.universal.js +33 -17
- package/build/cjs/src/forms-v4-submission.universal.js.map +1 -1
- package/build/es/src/forms-v4-submission.http.d.ts +6 -8
- package/build/es/src/forms-v4-submission.http.js +14 -18
- package/build/es/src/forms-v4-submission.http.js.map +1 -1
- package/build/es/src/forms-v4-submission.public.d.ts +3 -3
- package/build/es/src/forms-v4-submission.public.js +3 -3
- package/build/es/src/forms-v4-submission.public.js.map +1 -1
- package/build/es/src/forms-v4-submission.types.d.ts +34 -23
- package/build/es/src/forms-v4-submission.types.js.map +1 -1
- package/build/es/src/forms-v4-submission.universal.d.ts +70 -39
- package/build/es/src/forms-v4-submission.universal.js +31 -15
- package/build/es/src/forms-v4-submission.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -19,8 +19,8 @@ const _getMediaUploadURLRequest = {};
|
|
|
19
19
|
const _getMediaUploadURLResponse = {};
|
|
20
20
|
const _getSubmissionRequest = {};
|
|
21
21
|
const _getSubmissionResponse = { submission: '_formSubmission' };
|
|
22
|
-
const
|
|
23
|
-
const
|
|
22
|
+
const _querySubmissionsByNamespaceRequest = {};
|
|
23
|
+
const _querySubmissionsByNamespaceResponse = { submissions: '_formSubmission' };
|
|
24
24
|
const _updateSubmissionRequest = {
|
|
25
25
|
mask: 'google.protobuf.FieldMask',
|
|
26
26
|
submission: '_formSubmission',
|
|
@@ -161,11 +161,10 @@ export function updateSubmission(payload) {
|
|
|
161
161
|
return __updateSubmission;
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* Confirms a submission
|
|
164
|
+
* Confirms a submission.
|
|
165
165
|
*
|
|
166
166
|
*
|
|
167
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
168
|
-
* Currently, the default status when a submission is created is `CONFIRMED`. You can change the default status for individual submissions using the [Create Submission](https://dev.wix.com/api/rest//form-submissions/create-submission) or [Update Submission](https://dev.wix.com/api/rest//form-submissions/update-submission) endpoints. The ability to set the default status for all submissions to `PENDING` will be available using the upcoming Form Submissions SPI.
|
|
167
|
+
* You can only confirm a submission that has a `PENDING` status. The default status when a submission is created is `CONFIRMED`. You can change the default status for individual submissions using the [Create Submission](https://dev.wix.com/api/rest//form-submissions/create-submission) or [Update Submission](https://dev.wix.com/api/rest//form-submissions/update-submission) endpoints.
|
|
169
168
|
*/
|
|
170
169
|
export function confirmSubmission(payload) {
|
|
171
170
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_confirmSubmissionRequest, {});
|
|
@@ -217,26 +216,23 @@ export function deleteSubmission(payload) {
|
|
|
217
216
|
/**
|
|
218
217
|
* Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
|
|
219
218
|
*
|
|
220
|
-
*
|
|
221
219
|
* You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
|
|
222
220
|
*
|
|
223
221
|
* For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/form-submissions/sort-and-filter).option
|
|
224
222
|
*
|
|
225
223
|
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
226
224
|
*/
|
|
227
|
-
export function
|
|
228
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(
|
|
229
|
-
const { fromJSON: fromRes } = serializer(
|
|
230
|
-
|
|
231
|
-
});
|
|
232
|
-
function __querySubmission({ host }) {
|
|
225
|
+
export function querySubmissionsByNamespace(payload) {
|
|
226
|
+
const { toJSON: toReq, fromJSON: fromReq } = serializer(_querySubmissionsByNamespaceRequest, {});
|
|
227
|
+
const { fromJSON: fromRes } = serializer(_querySubmissionsByNamespaceResponse, { _formSubmission });
|
|
228
|
+
function __querySubmissionsByNamespace({ host }) {
|
|
233
229
|
const serializedData = toReq(payload);
|
|
234
230
|
const metadata = {
|
|
235
231
|
entityFqdn: 'wix.forms.v4.submission',
|
|
236
232
|
method: 'POST',
|
|
237
|
-
methodFqn: 'wix.forms.v4.FormSubmissionService.
|
|
233
|
+
methodFqn: 'wix.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace',
|
|
238
234
|
url: resolveWixFormsV4FormSubmissionServiceUrl({
|
|
239
|
-
protoPath: '/v4/submissions/query',
|
|
235
|
+
protoPath: '/v4/submissions/namespace/query',
|
|
240
236
|
data: serializedData,
|
|
241
237
|
host,
|
|
242
238
|
}),
|
|
@@ -245,10 +241,10 @@ export function querySubmission(payload) {
|
|
|
245
241
|
};
|
|
246
242
|
return metadata;
|
|
247
243
|
}
|
|
248
|
-
|
|
249
|
-
return
|
|
244
|
+
__querySubmissionsByNamespace.fromReq = fromReq;
|
|
245
|
+
return __querySubmissionsByNamespace;
|
|
250
246
|
}
|
|
251
|
-
/** Counts
|
|
247
|
+
/** Counts the submissions belonging to the specified forms. */
|
|
252
248
|
export function countSubmissions(payload) {
|
|
253
249
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_countSubmissionsRequest, {});
|
|
254
250
|
const { fromJSON: fromRes } = serializer(_countSubmissionsResponse, {});
|
|
@@ -294,7 +290,7 @@ export function getMediaUploadUrl(payload) {
|
|
|
294
290
|
__getMediaUploadUrl.fromReq = fromReq;
|
|
295
291
|
return __getMediaUploadUrl;
|
|
296
292
|
}
|
|
297
|
-
/** Marks form submissions as seen. */
|
|
293
|
+
/** Marks form submissions as seen by site collaborators with manage submission permissions. */
|
|
298
294
|
export function bulkMarkSubmissionsAsSeen(payload) {
|
|
299
295
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_bulkMarkSubmissionsAsSeenRequest, {});
|
|
300
296
|
const { fromJSON: fromRes } = serializer(_bulkMarkSubmissionsAsSeenResponse, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"forms-v4-submission.http.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAwBhD,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACrE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,wBAAwB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACnE,MAAM,yBAAyB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACpE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,eAAe,GAAG;IACtB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACjE,MAAM,
|
|
1
|
+
{"version":3,"file":"forms-v4-submission.http.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAwBhD,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACrE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,wBAAwB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACnE,MAAM,yBAAyB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACpE,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,eAAe,GAAG;IACtB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AACjE,MAAM,mCAAmC,GAAG,EAAE,CAAC;AAC/C,MAAM,oCAAoC,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;AAChF,MAAM,wBAAwB,GAAG;IAC/B,IAAI,EAAE,2BAA2B;IACjC,UAAU,EAAE,iBAAiB;CAC9B,CAAC;AACF,MAAM,yBAAyB,GAAG,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AAEpE,SAAS,yCAAyC,CAChD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,kBAAkB,EAAE;YAClB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,gCAAgC;AAChC,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE;QAClE,eAAe;KAChB,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,qDAAqD;YAChE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE;QAC/D,eAAe;KAChB,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,kDAAkD;YAC7D,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE;QAClE,eAAe;KAChB,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,qDAAqD;YAChE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,0BAA0B,EAAE;QACnE,eAAe;KAChB,CAAC,CAAC;IAEH,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,wCAAwC;gBACnD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEtC,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAExE,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,qDAAqD;YAChE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAA2C;IAE3C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,mCAAmC,EACnC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,oCAAoC,EACpC,EAAE,eAAe,EAAE,CACpB,CAAC;IAEF,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,gEAAgE;YAClE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,6BAA6B,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhD,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAExE,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,qDAAqD;YAChE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,kMAAkM;AAClM,MAAM,UAAU,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAEzE,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,kCAAkC;gBAC7C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEtC,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,yBAAyB,CACvC,OAAyC;IAEzC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,iCAAiC,EACjC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,kCAAkC,EAClC,EAAE,CACH,CAAC;IAEF,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,yCAAyC,CAAC;gBAC7C,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,2BAA2B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9C,OAAO,2BAA2B,CAAC;AACrC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { FormSubmission, UpdateSubmission, CountSubmissionsOptions, GetMediaUploadUrlOptions, BulkMarkSubmissionsAsSeenOptions, CreateSubmissionOptions,
|
|
2
|
+
import { FormSubmission, UpdateSubmission, CountSubmissionsOptions, GetMediaUploadUrlOptions, BulkMarkSubmissionsAsSeenOptions, CreateSubmissionOptions, QuerySubmissionsByNamespaceOptions } from './forms-v4-submission.universal';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
@@ -8,9 +8,9 @@ export declare function getSubmission(httpClient: HttpClient): (submissionId: st
|
|
|
8
8
|
export declare function updateSubmission(httpClient: HttpClient): (_id: string | null, submission: UpdateSubmission) => Promise<FormSubmission>;
|
|
9
9
|
export declare function confirmSubmission(httpClient: HttpClient): (submissionId: string) => Promise<import("./forms-v4-submission.universal").ConfirmSubmissionResponse>;
|
|
10
10
|
export declare function deleteSubmission(httpClient: HttpClient): (submissionId: string) => Promise<void>;
|
|
11
|
-
export declare function
|
|
11
|
+
export declare function querySubmissionsByNamespace(httpClient: HttpClient): (options?: QuerySubmissionsByNamespaceOptions | undefined) => import("./forms-v4-submission.universal").SubmissionsQueryBuilder;
|
|
12
12
|
export declare function countSubmissions(httpClient: HttpClient): (formIds: string[], options: CountSubmissionsOptions) => Promise<import("./forms-v4-submission.universal").CountSubmissionsResponse>;
|
|
13
13
|
export declare function getMediaUploadUrl(httpClient: HttpClient): (formId: string, options: GetMediaUploadUrlOptions) => Promise<import("./forms-v4-submission.universal").GetMediaUploadURLResponse>;
|
|
14
14
|
export declare function bulkMarkSubmissionsAsSeen(httpClient: HttpClient): (ids: string[], options: BulkMarkSubmissionsAsSeenOptions) => Promise<void>;
|
|
15
15
|
export { SubmissionStatus, IdentityType, SortOrder, } from './forms-v4-submission.universal';
|
|
16
|
-
export { FormSubmission, Owner, OwnerOwnerOneOf, Submitter, SubmitterSubmitterOneOf, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, Empty, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionResponse, SubmitContactResponse, SubmissionContactMapped, CreateSubmissionRequest, CreateSubmissionResponse, CreateSubmissionByOwnerRequest, CreateSubmissionByOwnerResponse, CreateSubmissionBySubmitterRequest, CreateSubmissionBySubmitterResponse, GetSubmissionRequest, GetSubmissionResponse, UpdateSubmissionRequest, UpdateSubmissionResponse, ConfirmSubmissionRequest, ConfirmSubmissionResponse, DeleteSubmissionRequest, DeleteSubmissionResponse, QuerySubmissionRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, CursorPaging, QuerySubmissionResponse, CursorPagingMetadata, Cursors, CountSubmissionsRequest, CountSubmissionsResponse, FormSubmissionsCount, GetMediaUploadURLRequest, GetMediaUploadURLResponse, BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse, Task, TaskKey, TaskAction, TaskActionActionOneOf, Complete, Cancel, Reschedule, CreateSubmissionOptions, UpdateSubmission,
|
|
16
|
+
export { FormSubmission, Owner, OwnerOwnerOneOf, Submitter, SubmitterSubmitterOneOf, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, Empty, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionResponse, SubmitContactResponse, SubmissionContactMapped, CreateSubmissionRequest, CreateSubmissionResponse, CreateSubmissionByOwnerRequest, CreateSubmissionByOwnerResponse, CreateSubmissionBySubmitterRequest, CreateSubmissionBySubmitterResponse, GetSubmissionRequest, GetSubmissionResponse, UpdateSubmissionRequest, UpdateSubmissionResponse, ConfirmSubmissionRequest, ConfirmSubmissionResponse, DeleteSubmissionRequest, DeleteSubmissionResponse, QuerySubmissionRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, CursorPaging, QuerySubmissionResponse, CursorPagingMetadata, Cursors, QuerySubmissionsByNamespaceRequest, QuerySubmissionsByNamespaceResponse, CountSubmissionsRequest, CountSubmissionsResponse, FormSubmissionsCount, GetMediaUploadURLRequest, GetMediaUploadURLResponse, BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse, Task, TaskKey, TaskAction, TaskActionActionOneOf, Complete, Cancel, Reschedule, CreateSubmissionOptions, UpdateSubmission, QuerySubmissionsByNamespaceOptions, SubmissionsQueryResult, SubmissionsQueryBuilder, CountSubmissionsOptions, GetMediaUploadUrlOptions, BulkMarkSubmissionsAsSeenOptions, } from './forms-v4-submission.universal';
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createSubmission as universalCreateSubmission, getSubmission as universalGetSubmission, updateSubmission as universalUpdateSubmission, confirmSubmission as universalConfirmSubmission, deleteSubmission as universalDeleteSubmission,
|
|
1
|
+
import { createSubmission as universalCreateSubmission, getSubmission as universalGetSubmission, updateSubmission as universalUpdateSubmission, confirmSubmission as universalConfirmSubmission, deleteSubmission as universalDeleteSubmission, querySubmissionsByNamespace as universalQuerySubmissionsByNamespace, countSubmissions as universalCountSubmissions, getMediaUploadUrl as universalGetMediaUploadUrl, bulkMarkSubmissionsAsSeen as universalBulkMarkSubmissionsAsSeen, } from './forms-v4-submission.universal';
|
|
2
2
|
export const __metadata = { PACKAGE_NAME: '@wix/forms' };
|
|
3
3
|
export function createSubmission(httpClient) {
|
|
4
4
|
return (submission, options) => universalCreateSubmission(submission, options,
|
|
@@ -25,8 +25,8 @@ export function deleteSubmission(httpClient) {
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
{ httpClient });
|
|
27
27
|
}
|
|
28
|
-
export function
|
|
29
|
-
return (options) =>
|
|
28
|
+
export function querySubmissionsByNamespace(httpClient) {
|
|
29
|
+
return (options) => universalQuerySubmissionsByNamespace(options,
|
|
30
30
|
// @ts-ignore
|
|
31
31
|
{ httpClient });
|
|
32
32
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"forms-v4-submission.public.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,IAAI,yBAAyB,EAC7C,aAAa,IAAI,sBAAsB,EACvC,gBAAgB,IAAI,yBAAyB,EAC7C,iBAAiB,IAAI,0BAA0B,EAC/C,gBAAgB,IAAI,yBAAyB,EAC7C,
|
|
1
|
+
{"version":3,"file":"forms-v4-submission.public.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,IAAI,yBAAyB,EAC7C,aAAa,IAAI,sBAAsB,EACvC,gBAAgB,IAAI,yBAAyB,EAC7C,iBAAiB,IAAI,0BAA0B,EAC/C,gBAAgB,IAAI,yBAAyB,EAC7C,2BAA2B,IAAI,oCAAoC,EACnE,gBAAgB,IAAI,yBAAyB,EAC7C,iBAAiB,IAAI,0BAA0B,EAC/C,yBAAyB,IAAI,kCAAkC,GAQhE,MAAM,iCAAiC,CAAC;AAEzC,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AAEzD,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,UAA0B,EAAE,OAAiC,EAAE,EAAE,CACvE,yBAAyB,CACvB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,YAAoB,EAAE,EAAE,CAC9B,sBAAsB,CACpB,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,GAAkB,EAAE,UAA4B,EAAE,EAAE,CAC1D,yBAAyB,CACvB,GAAG,EACH,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,YAAoB,EAAE,EAAE,CAC9B,0BAA0B,CACxB,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,YAAoB,EAAE,EAAE,CAC9B,yBAAyB,CACvB,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,UAAsB;IAChE,OAAO,CAAC,OAA4C,EAAE,EAAE,CACtD,oCAAoC,CAClC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,OAAiB,EAAE,OAAgC,EAAE,EAAE,CAC7D,yBAAyB,CACvB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,MAAc,EAAE,OAAiC,EAAE,EAAE,CAC3D,0BAA0B,CACxB,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,UAAsB;IAC9D,OAAO,CAAC,GAAa,EAAE,OAAyC,EAAE,EAAE,CAClE,kCAAkC,CAChC,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,SAAS,GACV,MAAM,iCAAiC,CAAC"}
|
|
@@ -1,19 +1,24 @@
|
|
|
1
|
+
/** Form submission that was created or retrieved. */
|
|
1
2
|
export interface FormSubmission {
|
|
2
3
|
/**
|
|
3
4
|
* Form submission ID.
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
id?: string | null;
|
|
7
|
-
/** ID of the form
|
|
8
|
+
/** ID of the form which submission belongs to. */
|
|
8
9
|
formId?: string;
|
|
9
10
|
/**
|
|
10
|
-
*
|
|
11
|
+
* The app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
|
|
11
12
|
* @readonly
|
|
12
13
|
*/
|
|
13
14
|
namespace?: string;
|
|
14
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Status of the submission.
|
|
17
|
+
* - `PENDING`: When a submission has been created, but has not yet been recorded in the submission table of the forms dashboard.
|
|
18
|
+
* - `CONFIRMED`: When a submission is recorded in the submissions table of the forms dashboard.
|
|
19
|
+
*/
|
|
15
20
|
status?: SubmissionStatus;
|
|
16
|
-
/** Submission values where key is
|
|
21
|
+
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
17
22
|
submissions?: Record<string, any>;
|
|
18
23
|
/**
|
|
19
24
|
* Date and time the form submission was created.
|
|
@@ -216,7 +221,7 @@ export interface SubmissionContactMapped {
|
|
|
216
221
|
namespace?: string;
|
|
217
222
|
}
|
|
218
223
|
export interface CreateSubmissionRequest {
|
|
219
|
-
/** Submission to
|
|
224
|
+
/** Submission to create. */
|
|
220
225
|
submission: FormSubmission;
|
|
221
226
|
/** Captcha token. */
|
|
222
227
|
captchaToken?: string | null;
|
|
@@ -226,7 +231,7 @@ export interface CreateSubmissionResponse {
|
|
|
226
231
|
submission?: FormSubmission;
|
|
227
232
|
}
|
|
228
233
|
export interface CreateSubmissionByOwnerRequest {
|
|
229
|
-
/** Submission to
|
|
234
|
+
/** Submission to create. */
|
|
230
235
|
submission?: FormSubmission;
|
|
231
236
|
}
|
|
232
237
|
export interface CreateSubmissionByOwnerResponse {
|
|
@@ -234,7 +239,7 @@ export interface CreateSubmissionByOwnerResponse {
|
|
|
234
239
|
submission?: FormSubmission;
|
|
235
240
|
}
|
|
236
241
|
export interface CreateSubmissionBySubmitterRequest {
|
|
237
|
-
/** Submission to
|
|
242
|
+
/** Submission to create. */
|
|
238
243
|
submission?: FormSubmission;
|
|
239
244
|
}
|
|
240
245
|
export interface CreateSubmissionBySubmitterResponse {
|
|
@@ -250,7 +255,7 @@ export interface GetSubmissionResponse {
|
|
|
250
255
|
submission?: FormSubmission;
|
|
251
256
|
}
|
|
252
257
|
export interface UpdateSubmissionRequest {
|
|
253
|
-
/** Submission to
|
|
258
|
+
/** Submission to update. */
|
|
254
259
|
submission: FormSubmission;
|
|
255
260
|
}
|
|
256
261
|
export interface UpdateSubmissionResponse {
|
|
@@ -258,7 +263,7 @@ export interface UpdateSubmissionResponse {
|
|
|
258
263
|
submission?: FormSubmission;
|
|
259
264
|
}
|
|
260
265
|
export interface ConfirmSubmissionRequest {
|
|
261
|
-
/** Submission
|
|
266
|
+
/** Submission ID to confirm. */
|
|
262
267
|
submissionId: string;
|
|
263
268
|
}
|
|
264
269
|
export interface ConfirmSubmissionResponse {
|
|
@@ -266,14 +271,14 @@ export interface ConfirmSubmissionResponse {
|
|
|
266
271
|
submission?: FormSubmission;
|
|
267
272
|
}
|
|
268
273
|
export interface DeleteSubmissionRequest {
|
|
269
|
-
/** ID of the submission to
|
|
274
|
+
/** ID of the submission to delete. */
|
|
270
275
|
submissionId: string;
|
|
271
276
|
}
|
|
272
277
|
export interface DeleteSubmissionResponse {
|
|
273
278
|
}
|
|
274
279
|
export interface QuerySubmissionRequest {
|
|
275
280
|
/** Query options. */
|
|
276
|
-
query
|
|
281
|
+
query?: CursorQuery;
|
|
277
282
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
278
283
|
onlyYourOwn?: boolean;
|
|
279
284
|
}
|
|
@@ -281,18 +286,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
281
286
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
282
287
|
cursorPaging?: CursorPaging;
|
|
283
288
|
/**
|
|
284
|
-
* Filter object
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
* "fieldName2":{"$operator":"value2"}
|
|
288
|
-
* }`
|
|
289
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
289
|
+
* Filter object.
|
|
290
|
+
*
|
|
291
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
|
|
290
292
|
*/
|
|
291
293
|
filter?: Record<string, any> | null;
|
|
292
|
-
/**
|
|
293
|
-
* Sort object in the following format:
|
|
294
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
295
|
-
*/
|
|
294
|
+
/** Sort object. */
|
|
296
295
|
sort?: Sorting[];
|
|
297
296
|
}
|
|
298
297
|
/** @oneof */
|
|
@@ -323,7 +322,7 @@ export interface CursorPaging {
|
|
|
323
322
|
cursor?: string | null;
|
|
324
323
|
}
|
|
325
324
|
export interface QuerySubmissionResponse {
|
|
326
|
-
/** The retrieved
|
|
325
|
+
/** The retrieved submissions. */
|
|
327
326
|
submissions?: FormSubmission[];
|
|
328
327
|
/** Paging metadata. */
|
|
329
328
|
metadata?: CursorPagingMetadata;
|
|
@@ -346,10 +345,22 @@ export interface Cursors {
|
|
|
346
345
|
/** Cursor pointing to previous page in the list of results. */
|
|
347
346
|
prev?: string | null;
|
|
348
347
|
}
|
|
348
|
+
export interface QuerySubmissionsByNamespaceRequest {
|
|
349
|
+
/** Query options. */
|
|
350
|
+
query: CursorQuery;
|
|
351
|
+
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
352
|
+
onlyYourOwn?: boolean;
|
|
353
|
+
}
|
|
354
|
+
export interface QuerySubmissionsByNamespaceResponse {
|
|
355
|
+
/** The retrieved Submissions. */
|
|
356
|
+
submissions?: FormSubmission[];
|
|
357
|
+
/** Paging metadata. */
|
|
358
|
+
metadata?: CursorPagingMetadata;
|
|
359
|
+
}
|
|
349
360
|
export interface CountSubmissionsRequest {
|
|
350
361
|
/** Form IDs. */
|
|
351
362
|
formIds: string[];
|
|
352
|
-
/** Identifies the
|
|
363
|
+
/** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */
|
|
353
364
|
namespace: string;
|
|
354
365
|
}
|
|
355
366
|
export interface CountSubmissionsResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"forms-v4-submission.types.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"forms-v4-submission.types.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.types.ts"],"names":[],"mappings":"AA8CA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;AACzB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAmKD,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,kDAAkD;IAClD,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qEAAqD,CAAA;AACvD,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAuHD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|
|
@@ -4,22 +4,27 @@ export declare const __debug: {
|
|
|
4
4
|
off: () => boolean;
|
|
5
5
|
};
|
|
6
6
|
};
|
|
7
|
+
/** Form submission that was created or retrieved. */
|
|
7
8
|
export interface FormSubmission {
|
|
8
9
|
/**
|
|
9
10
|
* Form submission ID.
|
|
10
11
|
* @readonly
|
|
11
12
|
*/
|
|
12
13
|
_id?: string | null;
|
|
13
|
-
/** ID of the form
|
|
14
|
+
/** ID of the form which submission belongs to. */
|
|
14
15
|
formId?: string;
|
|
15
16
|
/**
|
|
16
|
-
*
|
|
17
|
+
* The app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
|
|
17
18
|
* @readonly
|
|
18
19
|
*/
|
|
19
20
|
namespace?: string;
|
|
20
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Status of the submission.
|
|
23
|
+
* - `PENDING`: When a submission has been created, but has not yet been recorded in the submission table of the forms dashboard.
|
|
24
|
+
* - `CONFIRMED`: When a submission is recorded in the submissions table of the forms dashboard.
|
|
25
|
+
*/
|
|
21
26
|
status?: SubmissionStatus;
|
|
22
|
-
/** Submission values where key is
|
|
27
|
+
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
23
28
|
submissions?: Record<string, any>;
|
|
24
29
|
/**
|
|
25
30
|
* Date and time the form submission was created.
|
|
@@ -222,7 +227,7 @@ export interface SubmissionContactMapped {
|
|
|
222
227
|
namespace?: string;
|
|
223
228
|
}
|
|
224
229
|
export interface CreateSubmissionRequest {
|
|
225
|
-
/** Submission to
|
|
230
|
+
/** Submission to create. */
|
|
226
231
|
submission: FormSubmission;
|
|
227
232
|
/** Captcha token. */
|
|
228
233
|
captchaToken?: string | null;
|
|
@@ -232,7 +237,7 @@ export interface CreateSubmissionResponse {
|
|
|
232
237
|
submission?: FormSubmission;
|
|
233
238
|
}
|
|
234
239
|
export interface CreateSubmissionByOwnerRequest {
|
|
235
|
-
/** Submission to
|
|
240
|
+
/** Submission to create. */
|
|
236
241
|
submission?: FormSubmission;
|
|
237
242
|
}
|
|
238
243
|
export interface CreateSubmissionByOwnerResponse {
|
|
@@ -240,7 +245,7 @@ export interface CreateSubmissionByOwnerResponse {
|
|
|
240
245
|
submission?: FormSubmission;
|
|
241
246
|
}
|
|
242
247
|
export interface CreateSubmissionBySubmitterRequest {
|
|
243
|
-
/** Submission to
|
|
248
|
+
/** Submission to create. */
|
|
244
249
|
submission?: FormSubmission;
|
|
245
250
|
}
|
|
246
251
|
export interface CreateSubmissionBySubmitterResponse {
|
|
@@ -256,7 +261,7 @@ export interface GetSubmissionResponse {
|
|
|
256
261
|
submission?: FormSubmission;
|
|
257
262
|
}
|
|
258
263
|
export interface UpdateSubmissionRequest {
|
|
259
|
-
/** Submission to
|
|
264
|
+
/** Submission to update. */
|
|
260
265
|
submission: FormSubmission;
|
|
261
266
|
}
|
|
262
267
|
export interface UpdateSubmissionResponse {
|
|
@@ -264,7 +269,7 @@ export interface UpdateSubmissionResponse {
|
|
|
264
269
|
submission?: FormSubmission;
|
|
265
270
|
}
|
|
266
271
|
export interface ConfirmSubmissionRequest {
|
|
267
|
-
/** Submission
|
|
272
|
+
/** Submission ID to confirm. */
|
|
268
273
|
submissionId: string;
|
|
269
274
|
}
|
|
270
275
|
export interface ConfirmSubmissionResponse {
|
|
@@ -272,14 +277,14 @@ export interface ConfirmSubmissionResponse {
|
|
|
272
277
|
submission?: FormSubmission;
|
|
273
278
|
}
|
|
274
279
|
export interface DeleteSubmissionRequest {
|
|
275
|
-
/** ID of the submission to
|
|
280
|
+
/** ID of the submission to delete. */
|
|
276
281
|
submissionId: string;
|
|
277
282
|
}
|
|
278
283
|
export interface DeleteSubmissionResponse {
|
|
279
284
|
}
|
|
280
285
|
export interface QuerySubmissionRequest {
|
|
281
286
|
/** Query options. */
|
|
282
|
-
query
|
|
287
|
+
query?: CursorQuery;
|
|
283
288
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
284
289
|
onlyYourOwn?: boolean;
|
|
285
290
|
}
|
|
@@ -287,18 +292,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
287
292
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
288
293
|
cursorPaging?: CursorPaging;
|
|
289
294
|
/**
|
|
290
|
-
* Filter object
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
* "fieldName2":{"$operator":"value2"}
|
|
294
|
-
* }`
|
|
295
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
295
|
+
* Filter object.
|
|
296
|
+
*
|
|
297
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
|
|
296
298
|
*/
|
|
297
299
|
filter?: Record<string, any> | null;
|
|
298
|
-
/**
|
|
299
|
-
* Sort object in the following format:
|
|
300
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
301
|
-
*/
|
|
300
|
+
/** Sort object. */
|
|
302
301
|
sort?: Sorting[];
|
|
303
302
|
}
|
|
304
303
|
/** @oneof */
|
|
@@ -329,7 +328,7 @@ export interface CursorPaging {
|
|
|
329
328
|
cursor?: string | null;
|
|
330
329
|
}
|
|
331
330
|
export interface QuerySubmissionResponse {
|
|
332
|
-
/** The retrieved
|
|
331
|
+
/** The retrieved submissions. */
|
|
333
332
|
submissions?: FormSubmission[];
|
|
334
333
|
/** Paging metadata. */
|
|
335
334
|
metadata?: CursorPagingMetadata;
|
|
@@ -352,10 +351,22 @@ export interface Cursors {
|
|
|
352
351
|
/** Cursor pointing to previous page in the list of results. */
|
|
353
352
|
prev?: string | null;
|
|
354
353
|
}
|
|
354
|
+
export interface QuerySubmissionsByNamespaceRequest {
|
|
355
|
+
/** Query options. */
|
|
356
|
+
query: CursorQuery;
|
|
357
|
+
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
358
|
+
onlyYourOwn?: boolean;
|
|
359
|
+
}
|
|
360
|
+
export interface QuerySubmissionsByNamespaceResponse {
|
|
361
|
+
/** The retrieved Submissions. */
|
|
362
|
+
submissions?: FormSubmission[];
|
|
363
|
+
/** Paging metadata. */
|
|
364
|
+
metadata?: CursorPagingMetadata;
|
|
365
|
+
}
|
|
355
366
|
export interface CountSubmissionsRequest {
|
|
356
367
|
/** Form IDs. */
|
|
357
368
|
formIds: string[];
|
|
358
|
-
/** Identifies the
|
|
369
|
+
/** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */
|
|
359
370
|
namespace: string;
|
|
360
371
|
}
|
|
361
372
|
export interface CountSubmissionsResponse {
|
|
@@ -425,11 +436,13 @@ export interface Reschedule {
|
|
|
425
436
|
}
|
|
426
437
|
/**
|
|
427
438
|
* Creates a new submission.
|
|
428
|
-
* @param submission - Submission to
|
|
439
|
+
* @param submission - Submission to create.
|
|
429
440
|
* @public
|
|
430
441
|
* @documentationMaturity preview
|
|
431
442
|
* @requiredField submission
|
|
432
443
|
* @requiredField submission.formId
|
|
444
|
+
* @permissionScope Manage Submissions
|
|
445
|
+
* @applicableIdentity APP
|
|
433
446
|
* @applicableIdentity MEMBER
|
|
434
447
|
* @applicableIdentity VISITOR
|
|
435
448
|
*/
|
|
@@ -444,6 +457,8 @@ export interface CreateSubmissionOptions {
|
|
|
444
457
|
* @public
|
|
445
458
|
* @documentationMaturity preview
|
|
446
459
|
* @requiredField submissionId
|
|
460
|
+
* @permissionScope Read Submissions
|
|
461
|
+
* @applicableIdentity APP
|
|
447
462
|
* @returns The retrieved submission.
|
|
448
463
|
*/
|
|
449
464
|
export declare function getSubmission(submissionId: string): Promise<FormSubmission>;
|
|
@@ -458,6 +473,8 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
|
|
|
458
473
|
* @requiredField submission
|
|
459
474
|
* @requiredField submission.formId
|
|
460
475
|
* @requiredField submission.revision
|
|
476
|
+
* @permissionScope Manage Submissions
|
|
477
|
+
* @applicableIdentity APP
|
|
461
478
|
* @returns The updated submission.
|
|
462
479
|
*/
|
|
463
480
|
export declare function updateSubmission(_id: string | null, submission: UpdateSubmission): Promise<FormSubmission>;
|
|
@@ -467,16 +484,20 @@ export interface UpdateSubmission {
|
|
|
467
484
|
* @readonly
|
|
468
485
|
*/
|
|
469
486
|
_id?: string | null;
|
|
470
|
-
/** ID of the form
|
|
487
|
+
/** ID of the form which submission belongs to. */
|
|
471
488
|
formId?: string;
|
|
472
489
|
/**
|
|
473
|
-
*
|
|
490
|
+
* The app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
|
|
474
491
|
* @readonly
|
|
475
492
|
*/
|
|
476
493
|
namespace?: string;
|
|
477
|
-
/**
|
|
494
|
+
/**
|
|
495
|
+
* Status of the submission.
|
|
496
|
+
* - `PENDING`: When a submission has been created, but has not yet been recorded in the submission table of the forms dashboard.
|
|
497
|
+
* - `CONFIRMED`: When a submission is recorded in the submissions table of the forms dashboard.
|
|
498
|
+
*/
|
|
478
499
|
status?: SubmissionStatus;
|
|
479
|
-
/** Submission values where key is
|
|
500
|
+
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
480
501
|
submissions?: Record<string, any>;
|
|
481
502
|
/**
|
|
482
503
|
* Date and time the form submission was created.
|
|
@@ -502,29 +523,31 @@ export interface UpdateSubmission {
|
|
|
502
523
|
seen?: boolean;
|
|
503
524
|
}
|
|
504
525
|
/**
|
|
505
|
-
* Confirms a submission
|
|
526
|
+
* Confirms a submission.
|
|
506
527
|
*
|
|
507
528
|
*
|
|
508
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
509
|
-
*
|
|
510
|
-
* @param submissionId - Submission IDs.
|
|
529
|
+
* You can only confirm a submission that has a `PENDING` status. The default status when a submission is created is `CONFIRMED`. You can change the default status for individual submissions using the [Create Submission](https://dev.wix.com/api/rest//form-submissions/create-submission) or [Update Submission](https://dev.wix.com/api/rest//form-submissions/update-submission) endpoints.
|
|
530
|
+
* @param submissionId - Submission ID to confirm.
|
|
511
531
|
* @public
|
|
512
532
|
* @documentationMaturity preview
|
|
513
533
|
* @requiredField submissionId
|
|
534
|
+
* @permissionScope Manage Submissions
|
|
535
|
+
* @applicableIdentity APP
|
|
514
536
|
*/
|
|
515
537
|
export declare function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse>;
|
|
516
538
|
/**
|
|
517
539
|
* Deletes a submission by ID.
|
|
518
|
-
* @param submissionId - ID of the submission to
|
|
540
|
+
* @param submissionId - ID of the submission to delete.
|
|
519
541
|
* @public
|
|
520
542
|
* @documentationMaturity preview
|
|
521
543
|
* @requiredField submissionId
|
|
544
|
+
* @permissionScope Manage Submissions
|
|
545
|
+
* @applicableIdentity APP
|
|
522
546
|
*/
|
|
523
547
|
export declare function deleteSubmission(submissionId: string): Promise<void>;
|
|
524
548
|
/**
|
|
525
549
|
* Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
|
|
526
550
|
*
|
|
527
|
-
*
|
|
528
551
|
* You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
|
|
529
552
|
*
|
|
530
553
|
* For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/form-submissions/sort-and-filter).option
|
|
@@ -532,9 +555,11 @@ export declare function deleteSubmission(submissionId: string): Promise<void>;
|
|
|
532
555
|
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
533
556
|
* @public
|
|
534
557
|
* @documentationMaturity preview
|
|
558
|
+
* @permissionScope Read Submissions
|
|
559
|
+
* @applicableIdentity APP
|
|
535
560
|
*/
|
|
536
|
-
export declare function
|
|
537
|
-
export interface
|
|
561
|
+
export declare function querySubmissionsByNamespace(options?: QuerySubmissionsByNamespaceOptions): SubmissionsQueryBuilder;
|
|
562
|
+
export interface QuerySubmissionsByNamespaceOptions {
|
|
538
563
|
/** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
|
|
539
564
|
onlyYourOwn?: boolean | undefined;
|
|
540
565
|
}
|
|
@@ -599,17 +624,19 @@ export interface SubmissionsQueryBuilder {
|
|
|
599
624
|
find: () => Promise<SubmissionsQueryResult>;
|
|
600
625
|
}
|
|
601
626
|
/**
|
|
602
|
-
* Counts
|
|
627
|
+
* Counts the submissions belonging to the specified forms.
|
|
603
628
|
* @param formIds - Form IDs.
|
|
604
629
|
* @public
|
|
605
630
|
* @documentationMaturity preview
|
|
606
631
|
* @requiredField formIds
|
|
607
632
|
* @requiredField options
|
|
608
633
|
* @requiredField options.namespace
|
|
634
|
+
* @permissionScope Read Submissions
|
|
635
|
+
* @applicableIdentity APP
|
|
609
636
|
*/
|
|
610
637
|
export declare function countSubmissions(formIds: string[], options: CountSubmissionsOptions): Promise<CountSubmissionsResponse>;
|
|
611
638
|
export interface CountSubmissionsOptions {
|
|
612
|
-
/** Identifies the
|
|
639
|
+
/** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */
|
|
613
640
|
namespace: string;
|
|
614
641
|
}
|
|
615
642
|
/**
|
|
@@ -621,6 +648,8 @@ export interface CountSubmissionsOptions {
|
|
|
621
648
|
* @requiredField options
|
|
622
649
|
* @requiredField options.filename
|
|
623
650
|
* @requiredField options.mimeType
|
|
651
|
+
* @permissionScope Manage Submissions
|
|
652
|
+
* @applicableIdentity APP
|
|
624
653
|
* @applicableIdentity MEMBER
|
|
625
654
|
* @applicableIdentity VISITOR
|
|
626
655
|
*/
|
|
@@ -636,13 +665,15 @@ export interface GetMediaUploadUrlOptions {
|
|
|
636
665
|
mimeType: string;
|
|
637
666
|
}
|
|
638
667
|
/**
|
|
639
|
-
* Marks form submissions as seen.
|
|
668
|
+
* Marks form submissions as seen by site collaborators with manage submission permissions.
|
|
640
669
|
* @param ids - Submission IDs to mark as seen.
|
|
641
670
|
* @public
|
|
642
671
|
* @documentationMaturity preview
|
|
643
672
|
* @requiredField ids
|
|
644
673
|
* @requiredField options
|
|
645
674
|
* @requiredField options.formId
|
|
675
|
+
* @permissionScope Read Submissions
|
|
676
|
+
* @applicableIdentity APP
|
|
646
677
|
*/
|
|
647
678
|
export declare function bulkMarkSubmissionsAsSeen(ids: string[], options: BulkMarkSubmissionsAsSeenOptions): Promise<void>;
|
|
648
679
|
export interface BulkMarkSubmissionsAsSeenOptions {
|