@wix/forms 1.0.12 → 1.0.13
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 +4 -5
- package/build/cjs/src/forms-v4-submission.http.js +4 -5
- package/build/cjs/src/forms-v4-submission.http.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.types.d.ts +21 -22
- package/build/cjs/src/forms-v4-submission.types.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.universal.d.ts +55 -35
- package/build/cjs/src/forms-v4-submission.universal.js +25 -8
- package/build/cjs/src/forms-v4-submission.universal.js.map +1 -1
- package/build/es/src/forms-v4-submission.http.d.ts +4 -5
- package/build/es/src/forms-v4-submission.http.js +4 -5
- package/build/es/src/forms-v4-submission.http.js.map +1 -1
- package/build/es/src/forms-v4-submission.types.d.ts +21 -22
- package/build/es/src/forms-v4-submission.types.js.map +1 -1
- package/build/es/src/forms-v4-submission.universal.d.ts +55 -35
- package/build/es/src/forms-v4-submission.universal.js +25 -8
- package/build/es/src/forms-v4-submission.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -11,11 +11,10 @@ export declare function getSubmission(payload: GetSubmissionRequest): RequestOpt
|
|
|
11
11
|
*/
|
|
12
12
|
export declare function updateSubmission(payload: UpdateSubmissionRequest): RequestOptionsFactory<UpdateSubmissionResponse>;
|
|
13
13
|
/**
|
|
14
|
-
* Confirms a submission
|
|
14
|
+
* Confirms a submission.
|
|
15
15
|
*
|
|
16
16
|
*
|
|
17
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
18
|
-
* 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.
|
|
17
|
+
* 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.
|
|
19
18
|
*/
|
|
20
19
|
export declare function confirmSubmission(payload: ConfirmSubmissionRequest): RequestOptionsFactory<ConfirmSubmissionResponse>;
|
|
21
20
|
/** Deletes a submission by ID. */
|
|
@@ -31,9 +30,9 @@ export declare function deleteSubmission(payload: DeleteSubmissionRequest): Requ
|
|
|
31
30
|
* 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).
|
|
32
31
|
*/
|
|
33
32
|
export declare function querySubmission(payload: QuerySubmissionRequest): RequestOptionsFactory<QuerySubmissionResponse>;
|
|
34
|
-
/** Counts
|
|
33
|
+
/** Counts the submissions belonging to the specified forms. */
|
|
35
34
|
export declare function countSubmissions(payload: CountSubmissionsRequest): RequestOptionsFactory<CountSubmissionsResponse>;
|
|
36
35
|
/** Retrieves a URL, generated by [Media Manager](https://dev.wix.com/api/rest/media/media-manager/files/generate-file-upload-url), to allow clients to upload a file to a form for submission. */
|
|
37
36
|
export declare function getMediaUploadUrl(payload: GetMediaUploadURLRequest): RequestOptionsFactory<GetMediaUploadURLResponse>;
|
|
38
|
-
/** Marks form submissions as seen. */
|
|
37
|
+
/** Marks form submissions as seen by site collaborators with manage submission permissions. */
|
|
39
38
|
export declare function bulkMarkSubmissionsAsSeen(payload: BulkMarkSubmissionsAsSeenRequest): RequestOptionsFactory<BulkMarkSubmissionsAsSeenResponse>;
|
|
@@ -167,11 +167,10 @@ function updateSubmission(payload) {
|
|
|
167
167
|
}
|
|
168
168
|
exports.updateSubmission = updateSubmission;
|
|
169
169
|
/**
|
|
170
|
-
* Confirms a submission
|
|
170
|
+
* Confirms a submission.
|
|
171
171
|
*
|
|
172
172
|
*
|
|
173
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
174
|
-
* 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.
|
|
173
|
+
* 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.
|
|
175
174
|
*/
|
|
176
175
|
function confirmSubmission(payload) {
|
|
177
176
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_confirmSubmissionRequest, {});
|
|
@@ -257,7 +256,7 @@ function querySubmission(payload) {
|
|
|
257
256
|
return __querySubmission;
|
|
258
257
|
}
|
|
259
258
|
exports.querySubmission = querySubmission;
|
|
260
|
-
/** Counts
|
|
259
|
+
/** Counts the submissions belonging to the specified forms. */
|
|
261
260
|
function countSubmissions(payload) {
|
|
262
261
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_countSubmissionsRequest, {});
|
|
263
262
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_countSubmissionsResponse, {});
|
|
@@ -305,7 +304,7 @@ function getMediaUploadUrl(payload) {
|
|
|
305
304
|
return __getMediaUploadUrl;
|
|
306
305
|
}
|
|
307
306
|
exports.getMediaUploadUrl = getMediaUploadUrl;
|
|
308
|
-
/** Marks form submissions as seen. */
|
|
307
|
+
/** Marks form submissions as seen by site collaborators with manage submission permissions. */
|
|
309
308
|
function bulkMarkSubmissionsAsSeen(payload) {
|
|
310
309
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_bulkMarkSubmissionsAsSeenRequest, {});
|
|
311
310
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_bulkMarkSubmissionsAsSeenResponse, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"forms-v4-submission.http.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;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,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;AACpE,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,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,gCAAgC;AAChC,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AAhCD,4CAgCC;AAED,oCAAoC;AACpC,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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,IAAA,iCAAiB,EAAC,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;AAhCD,sCAgCC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AAhCD,4CAgCC;AAED
|
|
1
|
+
{"version":3,"file":"forms-v4-submission.http.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;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,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;AACpE,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,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,gCAAgC;AAChC,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AAhCD,4CAgCC;AAED,oCAAoC;AACpC,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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,IAAA,iCAAiB,EAAC,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;AAhCD,sCAgCC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,eAAe,EAAE,CACpB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AAhCD,4CAgCC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AAhCD,8CAgCC;AAED,kCAAkC;AAClC,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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,IAAA,iCAAiB,EAAC,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;AA9BD,4CA8BC;AAED;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,uBAAuB,EACvB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,wBAAwB,EAAE;QACjE,eAAe;KAChB,CAAC,CAAC;IAEH,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,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,iBAAiB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEpC,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAhCD,0CAgCC;AAED,+DAA+D;AAC/D,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA9BD,4CA8BC;AAED,kMAAkM;AAClM,SAAgB,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA9BD,8CA8BC;AAED,+FAA+F;AAC/F,SAAgB,yBAAyB,CACvC,OAAyC;IAEzC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,iCAAiC,EACjC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,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;AAjCD,8DAiCC"}
|
|
@@ -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,7 +271,7 @@ 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 {
|
|
@@ -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;
|
|
@@ -349,7 +348,7 @@ export interface Cursors {
|
|
|
349
348
|
export interface CountSubmissionsRequest {
|
|
350
349
|
/** Form IDs. */
|
|
351
350
|
formIds: string[];
|
|
352
|
-
/** Identifies the
|
|
351
|
+
/** 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
352
|
namespace: string;
|
|
354
353
|
}
|
|
355
354
|
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,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;AACzB,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AAmKD,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,GAAZ,oBAAY,KAAZ,oBAAY,QAQvB;AAuHD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,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,7 +277,7 @@ 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 {
|
|
@@ -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;
|
|
@@ -355,7 +354,7 @@ export interface Cursors {
|
|
|
355
354
|
export interface CountSubmissionsRequest {
|
|
356
355
|
/** Form IDs. */
|
|
357
356
|
formIds: string[];
|
|
358
|
-
/** Identifies the
|
|
357
|
+
/** 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
358
|
namespace: string;
|
|
360
359
|
}
|
|
361
360
|
export interface CountSubmissionsResponse {
|
|
@@ -425,11 +424,13 @@ export interface Reschedule {
|
|
|
425
424
|
}
|
|
426
425
|
/**
|
|
427
426
|
* Creates a new submission.
|
|
428
|
-
* @param submission - Submission to
|
|
427
|
+
* @param submission - Submission to create.
|
|
429
428
|
* @public
|
|
430
429
|
* @documentationMaturity preview
|
|
431
430
|
* @requiredField submission
|
|
432
431
|
* @requiredField submission.formId
|
|
432
|
+
* @permissionScope Manage Submissions
|
|
433
|
+
* @applicableIdentity APP
|
|
433
434
|
* @applicableIdentity MEMBER
|
|
434
435
|
* @applicableIdentity VISITOR
|
|
435
436
|
*/
|
|
@@ -444,6 +445,8 @@ export interface CreateSubmissionOptions {
|
|
|
444
445
|
* @public
|
|
445
446
|
* @documentationMaturity preview
|
|
446
447
|
* @requiredField submissionId
|
|
448
|
+
* @permissionScope Read Submissions
|
|
449
|
+
* @applicableIdentity APP
|
|
447
450
|
* @returns The retrieved submission.
|
|
448
451
|
*/
|
|
449
452
|
export declare function getSubmission(submissionId: string): Promise<FormSubmission>;
|
|
@@ -458,6 +461,8 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
|
|
|
458
461
|
* @requiredField submission
|
|
459
462
|
* @requiredField submission.formId
|
|
460
463
|
* @requiredField submission.revision
|
|
464
|
+
* @permissionScope Manage Submissions
|
|
465
|
+
* @applicableIdentity APP
|
|
461
466
|
* @returns The updated submission.
|
|
462
467
|
*/
|
|
463
468
|
export declare function updateSubmission(_id: string | null, submission: UpdateSubmission): Promise<FormSubmission>;
|
|
@@ -467,16 +472,20 @@ export interface UpdateSubmission {
|
|
|
467
472
|
* @readonly
|
|
468
473
|
*/
|
|
469
474
|
_id?: string | null;
|
|
470
|
-
/** ID of the form
|
|
475
|
+
/** ID of the form which submission belongs to. */
|
|
471
476
|
formId?: string;
|
|
472
477
|
/**
|
|
473
|
-
*
|
|
478
|
+
* 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
479
|
* @readonly
|
|
475
480
|
*/
|
|
476
481
|
namespace?: string;
|
|
477
|
-
/**
|
|
482
|
+
/**
|
|
483
|
+
* Status of the submission.
|
|
484
|
+
* - `PENDING`: When a submission has been created, but has not yet been recorded in the submission table of the forms dashboard.
|
|
485
|
+
* - `CONFIRMED`: When a submission is recorded in the submissions table of the forms dashboard.
|
|
486
|
+
*/
|
|
478
487
|
status?: SubmissionStatus;
|
|
479
|
-
/** Submission values where key is
|
|
488
|
+
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
480
489
|
submissions?: Record<string, any>;
|
|
481
490
|
/**
|
|
482
491
|
* Date and time the form submission was created.
|
|
@@ -502,23 +511,26 @@ export interface UpdateSubmission {
|
|
|
502
511
|
seen?: boolean;
|
|
503
512
|
}
|
|
504
513
|
/**
|
|
505
|
-
* Confirms a submission
|
|
514
|
+
* Confirms a submission.
|
|
506
515
|
*
|
|
507
516
|
*
|
|
508
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
509
|
-
*
|
|
510
|
-
* @param submissionId - Submission IDs.
|
|
517
|
+
* 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.
|
|
518
|
+
* @param submissionId - Submission ID to confirm.
|
|
511
519
|
* @public
|
|
512
520
|
* @documentationMaturity preview
|
|
513
521
|
* @requiredField submissionId
|
|
522
|
+
* @permissionScope Manage Submissions
|
|
523
|
+
* @applicableIdentity APP
|
|
514
524
|
*/
|
|
515
525
|
export declare function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse>;
|
|
516
526
|
/**
|
|
517
527
|
* Deletes a submission by ID.
|
|
518
|
-
* @param submissionId - ID of the submission to
|
|
528
|
+
* @param submissionId - ID of the submission to delete.
|
|
519
529
|
* @public
|
|
520
530
|
* @documentationMaturity preview
|
|
521
531
|
* @requiredField submissionId
|
|
532
|
+
* @permissionScope Manage Submissions
|
|
533
|
+
* @applicableIdentity APP
|
|
522
534
|
*/
|
|
523
535
|
export declare function deleteSubmission(submissionId: string): Promise<void>;
|
|
524
536
|
/**
|
|
@@ -532,6 +544,8 @@ export declare function deleteSubmission(submissionId: string): Promise<void>;
|
|
|
532
544
|
* 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
545
|
* @public
|
|
534
546
|
* @documentationMaturity preview
|
|
547
|
+
* @permissionScope Read Submissions
|
|
548
|
+
* @applicableIdentity APP
|
|
535
549
|
*/
|
|
536
550
|
export declare function querySubmission(options?: QuerySubmissionOptions): SubmissionsQueryBuilder;
|
|
537
551
|
export interface QuerySubmissionOptions {
|
|
@@ -599,17 +613,19 @@ export interface SubmissionsQueryBuilder {
|
|
|
599
613
|
find: () => Promise<SubmissionsQueryResult>;
|
|
600
614
|
}
|
|
601
615
|
/**
|
|
602
|
-
* Counts
|
|
616
|
+
* Counts the submissions belonging to the specified forms.
|
|
603
617
|
* @param formIds - Form IDs.
|
|
604
618
|
* @public
|
|
605
619
|
* @documentationMaturity preview
|
|
606
620
|
* @requiredField formIds
|
|
607
621
|
* @requiredField options
|
|
608
622
|
* @requiredField options.namespace
|
|
623
|
+
* @permissionScope Read Submissions
|
|
624
|
+
* @applicableIdentity APP
|
|
609
625
|
*/
|
|
610
626
|
export declare function countSubmissions(formIds: string[], options: CountSubmissionsOptions): Promise<CountSubmissionsResponse>;
|
|
611
627
|
export interface CountSubmissionsOptions {
|
|
612
|
-
/** Identifies the
|
|
628
|
+
/** 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
629
|
namespace: string;
|
|
614
630
|
}
|
|
615
631
|
/**
|
|
@@ -621,6 +637,8 @@ export interface CountSubmissionsOptions {
|
|
|
621
637
|
* @requiredField options
|
|
622
638
|
* @requiredField options.filename
|
|
623
639
|
* @requiredField options.mimeType
|
|
640
|
+
* @permissionScope Manage Submissions
|
|
641
|
+
* @applicableIdentity APP
|
|
624
642
|
* @applicableIdentity MEMBER
|
|
625
643
|
* @applicableIdentity VISITOR
|
|
626
644
|
*/
|
|
@@ -636,13 +654,15 @@ export interface GetMediaUploadUrlOptions {
|
|
|
636
654
|
mimeType: string;
|
|
637
655
|
}
|
|
638
656
|
/**
|
|
639
|
-
* Marks form submissions as seen.
|
|
657
|
+
* Marks form submissions as seen by site collaborators with manage submission permissions.
|
|
640
658
|
* @param ids - Submission IDs to mark as seen.
|
|
641
659
|
* @public
|
|
642
660
|
* @documentationMaturity preview
|
|
643
661
|
* @requiredField ids
|
|
644
662
|
* @requiredField options
|
|
645
663
|
* @requiredField options.formId
|
|
664
|
+
* @permissionScope Read Submissions
|
|
665
|
+
* @applicableIdentity APP
|
|
646
666
|
*/
|
|
647
667
|
export declare function bulkMarkSubmissionsAsSeen(ids: string[], options: BulkMarkSubmissionsAsSeenOptions): Promise<void>;
|
|
648
668
|
export interface BulkMarkSubmissionsAsSeenOptions {
|
|
@@ -89,11 +89,13 @@ const _updateSubmissionRequest = {};
|
|
|
89
89
|
const _updateSubmissionResponse = {};
|
|
90
90
|
/**
|
|
91
91
|
* Creates a new submission.
|
|
92
|
-
* @param submission - Submission to
|
|
92
|
+
* @param submission - Submission to create.
|
|
93
93
|
* @public
|
|
94
94
|
* @documentationMaturity preview
|
|
95
95
|
* @requiredField submission
|
|
96
96
|
* @requiredField submission.formId
|
|
97
|
+
* @permissionScope Manage Submissions
|
|
98
|
+
* @applicableIdentity APP
|
|
97
99
|
* @applicableIdentity MEMBER
|
|
98
100
|
* @applicableIdentity VISITOR
|
|
99
101
|
*/
|
|
@@ -151,6 +153,8 @@ exports.createSubmission = createSubmission;
|
|
|
151
153
|
* @public
|
|
152
154
|
* @documentationMaturity preview
|
|
153
155
|
* @requiredField submissionId
|
|
156
|
+
* @permissionScope Read Submissions
|
|
157
|
+
* @applicableIdentity APP
|
|
154
158
|
* @returns The retrieved submission.
|
|
155
159
|
*/
|
|
156
160
|
function getSubmission(submissionId) {
|
|
@@ -208,6 +212,8 @@ exports.getSubmission = getSubmission;
|
|
|
208
212
|
* @requiredField submission
|
|
209
213
|
* @requiredField submission.formId
|
|
210
214
|
* @requiredField submission.revision
|
|
215
|
+
* @permissionScope Manage Submissions
|
|
216
|
+
* @applicableIdentity APP
|
|
211
217
|
* @returns The updated submission.
|
|
212
218
|
*/
|
|
213
219
|
function updateSubmission(_id, submission) {
|
|
@@ -256,15 +262,16 @@ function updateSubmission(_id, submission) {
|
|
|
256
262
|
}
|
|
257
263
|
exports.updateSubmission = updateSubmission;
|
|
258
264
|
/**
|
|
259
|
-
* Confirms a submission
|
|
265
|
+
* Confirms a submission.
|
|
260
266
|
*
|
|
261
267
|
*
|
|
262
|
-
* You can only confirm a submission that has a `PENDING` status.
|
|
263
|
-
*
|
|
264
|
-
* @param submissionId - Submission IDs.
|
|
268
|
+
* 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.
|
|
269
|
+
* @param submissionId - Submission ID to confirm.
|
|
265
270
|
* @public
|
|
266
271
|
* @documentationMaturity preview
|
|
267
272
|
* @requiredField submissionId
|
|
273
|
+
* @permissionScope Manage Submissions
|
|
274
|
+
* @applicableIdentity APP
|
|
268
275
|
*/
|
|
269
276
|
function confirmSubmission(submissionId) {
|
|
270
277
|
var _a, _b, _c;
|
|
@@ -312,10 +319,12 @@ function confirmSubmission(submissionId) {
|
|
|
312
319
|
exports.confirmSubmission = confirmSubmission;
|
|
313
320
|
/**
|
|
314
321
|
* Deletes a submission by ID.
|
|
315
|
-
* @param submissionId - ID of the submission to
|
|
322
|
+
* @param submissionId - ID of the submission to delete.
|
|
316
323
|
* @public
|
|
317
324
|
* @documentationMaturity preview
|
|
318
325
|
* @requiredField submissionId
|
|
326
|
+
* @permissionScope Manage Submissions
|
|
327
|
+
* @applicableIdentity APP
|
|
319
328
|
*/
|
|
320
329
|
function deleteSubmission(submissionId) {
|
|
321
330
|
var _a, _b, _c;
|
|
@@ -372,6 +381,8 @@ exports.deleteSubmission = deleteSubmission;
|
|
|
372
381
|
* 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).
|
|
373
382
|
* @public
|
|
374
383
|
* @documentationMaturity preview
|
|
384
|
+
* @permissionScope Read Submissions
|
|
385
|
+
* @applicableIdentity APP
|
|
375
386
|
*/
|
|
376
387
|
function querySubmission(options) {
|
|
377
388
|
const requestTransformation = { '*': '$[1]', query: '$[0]' };
|
|
@@ -426,13 +437,15 @@ function querySubmission(options) {
|
|
|
426
437
|
}
|
|
427
438
|
exports.querySubmission = querySubmission;
|
|
428
439
|
/**
|
|
429
|
-
* Counts
|
|
440
|
+
* Counts the submissions belonging to the specified forms.
|
|
430
441
|
* @param formIds - Form IDs.
|
|
431
442
|
* @public
|
|
432
443
|
* @documentationMaturity preview
|
|
433
444
|
* @requiredField formIds
|
|
434
445
|
* @requiredField options
|
|
435
446
|
* @requiredField options.namespace
|
|
447
|
+
* @permissionScope Read Submissions
|
|
448
|
+
* @applicableIdentity APP
|
|
436
449
|
*/
|
|
437
450
|
function countSubmissions(formIds, options) {
|
|
438
451
|
var _a, _b, _c;
|
|
@@ -491,6 +504,8 @@ exports.countSubmissions = countSubmissions;
|
|
|
491
504
|
* @requiredField options
|
|
492
505
|
* @requiredField options.filename
|
|
493
506
|
* @requiredField options.mimeType
|
|
507
|
+
* @permissionScope Manage Submissions
|
|
508
|
+
* @applicableIdentity APP
|
|
494
509
|
* @applicableIdentity MEMBER
|
|
495
510
|
* @applicableIdentity VISITOR
|
|
496
511
|
*/
|
|
@@ -544,13 +559,15 @@ function getMediaUploadUrl(formId, options) {
|
|
|
544
559
|
}
|
|
545
560
|
exports.getMediaUploadUrl = getMediaUploadUrl;
|
|
546
561
|
/**
|
|
547
|
-
* Marks form submissions as seen.
|
|
562
|
+
* Marks form submissions as seen by site collaborators with manage submission permissions.
|
|
548
563
|
* @param ids - Submission IDs to mark as seen.
|
|
549
564
|
* @public
|
|
550
565
|
* @documentationMaturity preview
|
|
551
566
|
* @requiredField ids
|
|
552
567
|
* @requiredField options
|
|
553
568
|
* @requiredField options.formId
|
|
569
|
+
* @permissionScope Read Submissions
|
|
570
|
+
* @applicableIdentity APP
|
|
554
571
|
*/
|
|
555
572
|
function bulkMarkSubmissionsAsSeen(ids, options) {
|
|
556
573
|
var _a, _b, _c;
|