@wix/forms 1.0.7 → 1.0.9

package/build/cjs/src/forms-v4-submission.http.d.ts

@@ -2,22 +2,41 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 import { BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse, ConfirmSubmissionRequest, ConfirmSubmissionResponse, CountSubmissionsRequest, CountSubmissionsResponse, CreateSubmissionRequest, CreateSubmissionResponse, DeleteSubmissionRequest, DeleteSubmissionResponse, GetMediaUploadURLRequest, GetMediaUploadURLResponse, GetSubmissionRequest, GetSubmissionResponse, QuerySubmissionRequest, QuerySubmissionResponse, UpdateSubmissionRequest, UpdateSubmissionResponse } from './forms-v4-submission.types';
 /** Creates a new submission. */
 export declare function createSubmission(payload: CreateSubmissionRequest): RequestOptionsFactory<CreateSubmissionResponse>;
-/** Gets a submission by id. */
+/** Retrieves a submission by ID. */
 export declare function getSubmission(payload: GetSubmissionRequest): RequestOptionsFactory<GetSubmissionResponse>;
 /**
- * Updates a submission, supports partial update.
- * You need to pass the latest 'revision' for a successful update.
+ * Updates a submission.
+ *
+ * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
  */
 export declare function updateSubmission(payload: UpdateSubmissionRequest): RequestOptionsFactory<UpdateSubmissionResponse>;
-/** Change submission status to 'CONFIRMED' */
+/**
+ * Confirms a submission and changes the submission status to `CONFIRMED`.
+ *
+ *
+ * You can only confirm a submission that has a `PENDING` status.
+ * Currently, the default status when a submission is created is `CONFIRMED`. You can override the default status when using the [Create Submission](#) endpoints. change the status of a submission using the [`Update Submission`](#) endpoints. The ability to set the default status to `PENDING` will be availbe using the upcoming Form Submissions SPI.
+ */
 export declare function confirmSubmission(payload: ConfirmSubmissionRequest): RequestOptionsFactory<ConfirmSubmissionResponse>;
-/** Deletes a submission. */
+/** Deletes a submission by ID. */
 export declare function deleteSubmission(payload: DeleteSubmissionRequest): RequestOptionsFactory<DeleteSubmissionResponse>;
-/** Query submissions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
+/**
+ * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
+ *
+ *
+ * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
+ *
+ * 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
+ *
+ * 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).
+ */
 export declare function querySubmission(payload: QuerySubmissionRequest): RequestOptionsFactory<QuerySubmissionResponse>;
-/** Counts forms submissions. */
+/** Counts ths submissions beloning to the specified forms. */
 export declare function countSubmissions(payload: CountSubmissionsRequest): RequestOptionsFactory<CountSubmissionsResponse>;
-/** Returns url to upload media file. */
+/**
+ * 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.
+ * Returns url to upload media file.
+ */
 export declare function getMediaUploadUrl(payload: GetMediaUploadURLRequest): RequestOptionsFactory<GetMediaUploadURLResponse>;
-/** Marks submissions as seen. */
+/** Marks form submissions as seen. */
 export declare function bulkMarkSubmissionsAsSeen(payload: BulkMarkSubmissionsAsSeenRequest): RequestOptionsFactory<BulkMarkSubmissionsAsSeenResponse>;

package/build/cjs/src/forms-v4-submission.http.js

@@ -110,7 +110,7 @@ function createSubmission(payload) {
     return __createSubmission;
 }
 exports.createSubmission = createSubmission;
-/** Gets a submission by id. */
+/** Retrieves a submission by ID. */
 function getSubmission(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getSubmissionRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getSubmissionResponse, {
@@ -137,8 +137,9 @@ function getSubmission(payload) {
 }
 exports.getSubmission = getSubmission;
 /**
- * Updates a submission, supports partial update.
- * You need to pass the latest 'revision' for a successful update.
+ * Updates a submission.
+ *
+ * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
  */
 function updateSubmission(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateSubmissionRequest, { _formSubmission });
@@ -165,7 +166,13 @@ function updateSubmission(payload) {
     return __updateSubmission;
 }
 exports.updateSubmission = updateSubmission;
-/** Change submission status to 'CONFIRMED' */
+/**
+ * Confirms a submission and changes the submission status to `CONFIRMED`.
+ *
+ *
+ * You can only confirm a submission that has a `PENDING` status.
+ * Currently, the default status when a submission is created is `CONFIRMED`. You can override the default status when using the [Create Submission](#) endpoints. change the status of a submission using the [`Update Submission`](#) endpoints. The ability to set the default status to `PENDING` will be availbe using the upcoming Form Submissions SPI.
+ */
 function confirmSubmission(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_confirmSubmissionRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_confirmSubmissionResponse, {
@@ -191,7 +198,7 @@ function confirmSubmission(payload) {
     return __confirmSubmission;
 }
 exports.confirmSubmission = confirmSubmission;
-/** Deletes a submission. */
+/** Deletes a submission by ID. */
 function deleteSubmission(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteSubmissionRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_deleteSubmissionResponse, {});
@@ -215,7 +222,16 @@ function deleteSubmission(payload) {
     return __deleteSubmission;
 }
 exports.deleteSubmission = deleteSubmission;
-/** Query submissions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
+/**
+ * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
+ *
+ *
+ * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
+ *
+ * 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
+ *
+ * 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).
+ */
 function querySubmission(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_querySubmissionRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_querySubmissionResponse, {
@@ -241,7 +257,7 @@ function querySubmission(payload) {
     return __querySubmission;
 }
 exports.querySubmission = querySubmission;
-/** Counts forms submissions. */
+/** Counts ths submissions beloning to the specified forms. */
 function countSubmissions(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_countSubmissionsRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_countSubmissionsResponse, {});
@@ -265,7 +281,10 @@ function countSubmissions(payload) {
     return __countSubmissions;
 }
 exports.countSubmissions = countSubmissions;
-/** Returns url to upload media file. */
+/**
+ * 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.
+ * Returns url to upload media file.
+ */
 function getMediaUploadUrl(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getMediaUploadURLRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getMediaUploadURLResponse, {});
@@ -289,7 +308,7 @@ function getMediaUploadUrl(payload) {
     return __getMediaUploadUrl;
 }
 exports.getMediaUploadUrl = getMediaUploadUrl;
-/** Marks submissions as seen. */
+/** Marks form submissions as seen. */
 function bulkMarkSubmissionsAsSeen(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_bulkMarkSubmissionsAsSeenRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_bulkMarkSubmissionsAsSeenResponse, {});

package/build/cjs/src/forms-v4-submission.http.js.map

@@ -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,+BAA+B;AAC/B,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;;;GAGG;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,8CAA8C;AAC9C,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,4BAA4B;AAC5B,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,2HAA2H;AAC3H,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,gCAAgC;AAChC,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,wCAAwC;AACxC,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,iCAAiC;AACjC,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"}
+{"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;;;;;;GAMG;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,8DAA8D;AAC9D,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;;;GAGG;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,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,sCAAsC;AACtC,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"}

package/build/cjs/src/forms-v4-submission.types.d.ts

@@ -35,7 +35,7 @@ export interface FormSubmission {
      * @readonly
      */
     submitter?: Submitter;
-    /** Whether the submission was read by a user. */
+    /** Whether the submission was read by a site contributor with Manage Permissions. */
     seen?: boolean;
 }
 export declare enum SubmissionStatus {
@@ -77,7 +77,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
     serviceId?: string | null;
     /** User ID. */
     userId?: string | null;
-    /** External app ID. */
+    /** App ID. */
     externalAppId?: string | null;
 }
 /** @oneof */
@@ -90,7 +90,7 @@ export interface SubmitterSubmitterOneOf {
     serviceId?: string | null;
     /** User ID. */
     userId?: string | null;
-    /** External app ID. */
+    /** App ID. */
     externalAppId?: string | null;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -218,7 +218,7 @@ export interface SubmissionContactMapped {
 export interface CreateSubmissionRequest {
     /** Submission to be created. */
     submission: FormSubmission;
-    /** Captcha token */
+    /** Captcha token. */
     captchaToken?: string | null;
 }
 export interface CreateSubmissionResponse {
@@ -242,7 +242,7 @@ export interface CreateSubmissionBySubmitterResponse {
     submission?: FormSubmission;
 }
 export interface GetSubmissionRequest {
-    /** Id of the submission to retrieve. */
+    /** ID of the submission to retrieve. */
     submissionId: string;
 }
 export interface GetSubmissionResponse {
@@ -250,7 +250,7 @@ export interface GetSubmissionResponse {
     submission?: FormSubmission;
 }
 export interface UpdateSubmissionRequest {
-    /** Submission to be updated, may be partial. */
+    /** Submission to be updated. */
     submission: FormSubmission;
 }
 export interface UpdateSubmissionResponse {
@@ -258,23 +258,23 @@ export interface UpdateSubmissionResponse {
     submission?: FormSubmission;
 }
 export interface ConfirmSubmissionRequest {
-    /** Submission id. */
+    /** Submission IDs. */
     submissionId: string;
 }
 export interface ConfirmSubmissionResponse {
-    /** Confirmed submission. */
+    /** Submission that was confirmed. */
     submission?: FormSubmission;
 }
 export interface DeleteSubmissionRequest {
-    /** Id of the submission to delete. */
+    /** ID of the submission to be deleted. */
     submissionId: string;
 }
 export interface DeleteSubmissionResponse {
 }
 export interface QuerySubmissionRequest {
-    /** WQL expression. */
+    /** Query options. */
     query: CursorQuery;
-    /** Return only own submissions. */
+    /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
     onlyYourOwn?: boolean;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -353,23 +353,27 @@ export interface CountSubmissionsRequest {
     namespace: string;
 }
 export interface CountSubmissionsResponse {
-    /** Forms submissions count. */
+    /** Forms submission count. */
     formsSubmissionsCount?: FormSubmissionsCount[];
 }
 export interface FormSubmissionsCount {
     /** Form ID. */
     formId?: string;
-    /** Total form submissions count. */
+    /** Total number of submissions. */
     totalCount?: number;
-    /** Unseen form submissions count. */
+    /** Number of submissions that haven't been seen. */
     unseenCount?: number;
 }
 export interface GetMediaUploadURLRequest {
-    /** Form id. */
+    /** Form ID. */
     formId: string;
     /** Name of file to upload. */
     filename: string;
-    /** Mime type of file to upload. */
+    /**
+     * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
+     *
+     * For example, `'image/png'`
+     */
     mimeType: string;
 }
 export interface GetMediaUploadURLResponse {
@@ -377,9 +381,9 @@ export interface GetMediaUploadURLResponse {
     uploadUrl?: string;
 }
 export interface BulkMarkSubmissionsAsSeenRequest {
-    /** Submission ids to mark as seen. */
+    /** Submission IDs to mark as seen. */
     ids: string[];
-    /** Submissions form id. */
+    /** ID of the form to which the submissions belongs. */
     formId: string;
 }
 export interface BulkMarkSubmissionsAsSeenResponse {

package/build/cjs/src/forms-v4-submission.universal.d.ts

@@ -41,7 +41,7 @@ export interface FormSubmission {
      * @readonly
      */
     submitter?: Submitter;
-    /** Whether the submission was read by a user. */
+    /** Whether the submission was read by a site contributor with Manage Permissions. */
     seen?: boolean;
 }
 export declare enum SubmissionStatus {
@@ -83,7 +83,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
     serviceId?: string | null;
     /** User ID. */
     userId?: string | null;
-    /** External app ID. */
+    /** App ID. */
     externalAppId?: string | null;
 }
 /** @oneof */
@@ -96,7 +96,7 @@ export interface SubmitterSubmitterOneOf {
     serviceId?: string | null;
     /** User ID. */
     userId?: string | null;
-    /** External app ID. */
+    /** App ID. */
     externalAppId?: string | null;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -224,7 +224,7 @@ export interface SubmissionContactMapped {
 export interface CreateSubmissionRequest {
     /** Submission to be created. */
     submission: FormSubmission;
-    /** Captcha token */
+    /** Captcha token. */
     captchaToken?: string | null;
 }
 export interface CreateSubmissionResponse {
@@ -248,7 +248,7 @@ export interface CreateSubmissionBySubmitterResponse {
     submission?: FormSubmission;
 }
 export interface GetSubmissionRequest {
-    /** Id of the submission to retrieve. */
+    /** ID of the submission to retrieve. */
     submissionId: string;
 }
 export interface GetSubmissionResponse {
@@ -256,7 +256,7 @@ export interface GetSubmissionResponse {
     submission?: FormSubmission;
 }
 export interface UpdateSubmissionRequest {
-    /** Submission to be updated, may be partial. */
+    /** Submission to be updated. */
     submission: FormSubmission;
 }
 export interface UpdateSubmissionResponse {
@@ -264,23 +264,23 @@ export interface UpdateSubmissionResponse {
     submission?: FormSubmission;
 }
 export interface ConfirmSubmissionRequest {
-    /** Submission id. */
+    /** Submission IDs. */
     submissionId: string;
 }
 export interface ConfirmSubmissionResponse {
-    /** Confirmed submission. */
+    /** Submission that was confirmed. */
     submission?: FormSubmission;
 }
 export interface DeleteSubmissionRequest {
-    /** Id of the submission to delete. */
+    /** ID of the submission to be deleted. */
     submissionId: string;
 }
 export interface DeleteSubmissionResponse {
 }
 export interface QuerySubmissionRequest {
-    /** WQL expression. */
+    /** Query options. */
     query: CursorQuery;
-    /** Return only own submissions. */
+    /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
     onlyYourOwn?: boolean;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -359,23 +359,27 @@ export interface CountSubmissionsRequest {
     namespace: string;
 }
 export interface CountSubmissionsResponse {
-    /** Forms submissions count. */
+    /** Forms submission count. */
     formsSubmissionsCount?: FormSubmissionsCount[];
 }
 export interface FormSubmissionsCount {
     /** Form ID. */
     formId?: string;
-    /** Total form submissions count. */
+    /** Total number of submissions. */
     totalCount?: number;
-    /** Unseen form submissions count. */
+    /** Number of submissions that haven't been seen. */
     unseenCount?: number;
 }
 export interface GetMediaUploadURLRequest {
-    /** Form id. */
+    /** Form ID. */
     formId: string;
     /** Name of file to upload. */
     filename: string;
-    /** Mime type of file to upload. */
+    /**
+     * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
+     *
+     * For example, `'image/png'`
+     */
     mimeType: string;
 }
 export interface GetMediaUploadURLResponse {
@@ -383,9 +387,9 @@ export interface GetMediaUploadURLResponse {
     uploadUrl?: string;
 }
 export interface BulkMarkSubmissionsAsSeenRequest {
-    /** Submission ids to mark as seen. */
+    /** Submission IDs to mark as seen. */
     ids: string[];
-    /** Submissions form id. */
+    /** ID of the form to which the submissions belongs. */
     formId: string;
 }
 export interface BulkMarkSubmissionsAsSeenResponse {
@@ -431,12 +435,12 @@ export interface Reschedule {
  */
 export declare function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise<CreateSubmissionResponse>;
 export interface CreateSubmissionOptions {
-    /** Captcha token */
+    /** Captcha token. */
     captchaToken?: string | null;
 }
 /**
- * Gets a submission by id.
- * @param submissionId - Id of the submission to retrieve.
+ * Retrieves a submission by ID.
+ * @param submissionId - ID of the submission to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
@@ -444,8 +448,9 @@ export interface CreateSubmissionOptions {
  */
 export declare function getSubmission(submissionId: string): Promise<FormSubmission>;
 /**
- * Updates a submission, supports partial update.
- * You need to pass the latest 'revision' for a successful update.
+ * Updates a submission.
+ *
+ * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
  * @param _id - Form submission ID.
  * @public
  * @documentationMaturity preview
@@ -493,33 +498,44 @@ export interface UpdateSubmission {
      * @readonly
      */
     submitter?: Submitter;
-    /** Whether the submission was read by a user. */
+    /** Whether the submission was read by a site contributor with Manage Permissions. */
     seen?: boolean;
 }
 /**
- * Change submission status to 'CONFIRMED'
- * @param submissionId - Submission id.
+ * Confirms a submission and changes the submission status to `CONFIRMED`.
+ *
+ *
+ * You can only confirm a submission that has a `PENDING` status.
+ * Currently, the default status when a submission is created is `CONFIRMED`. You can override the default status when using the [Create Submission](#) endpoints. change the status of a submission using the [`Update Submission`](#) endpoints. The ability to set the default status to `PENDING` will be availbe using the upcoming Form Submissions SPI.
+ * @param submissionId - Submission IDs.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
  */
 export declare function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse>;
 /**
- * Deletes a submission.
- * @param submissionId - Id of the submission to delete.
+ * Deletes a submission by ID.
+ * @param submissionId - ID of the submission to be deleted.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
  */
 export declare function deleteSubmission(submissionId: string): Promise<void>;
 /**
- * Query submissions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
+ *
+ *
+ * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
+ *
+ * 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
+ *
+ * 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).
  * @public
  * @documentationMaturity preview
  */
 export declare function querySubmission(options?: QuerySubmissionOptions): SubmissionsQueryBuilder;
 export interface QuerySubmissionOptions {
-    /** Return only own submissions. */
+    /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
     onlyYourOwn?: boolean | undefined;
 }
 interface QueryCursorResult {
@@ -583,7 +599,7 @@ export interface SubmissionsQueryBuilder {
     find: () => Promise<SubmissionsQueryResult>;
 }
 /**
- * Counts forms submissions.
+ * Counts ths submissions beloning to the specified forms.
  * @param formIds - Form IDs.
  * @public
  * @documentationMaturity preview
@@ -597,8 +613,9 @@ export interface CountSubmissionsOptions {
     namespace: string;
 }
 /**
+ * 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.
  * Returns url to upload media file.
- * @param formId - Form id.
+ * @param formId - Form ID.
  * @public
  * @documentationMaturity preview
  * @requiredField formId
@@ -612,12 +629,16 @@ export declare function getMediaUploadUrl(formId: string, options: GetMediaUploa
 export interface GetMediaUploadUrlOptions {
     /** Name of file to upload. */
     filename: string;
-    /** Mime type of file to upload. */
+    /**
+     * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
+     *
+     * For example, `'image/png'`
+     */
     mimeType: string;
 }
 /**
- * Marks submissions as seen.
- * @param ids - Submission ids to mark as seen.
+ * Marks form submissions as seen.
+ * @param ids - Submission IDs to mark as seen.
  * @public
  * @documentationMaturity preview
  * @requiredField ids
@@ -626,7 +647,7 @@ export interface GetMediaUploadUrlOptions {
  */
 export declare function bulkMarkSubmissionsAsSeen(ids: string[], options: BulkMarkSubmissionsAsSeenOptions): Promise<void>;
 export interface BulkMarkSubmissionsAsSeenOptions {
-    /** Submissions form id. */
+    /** ID of the form to which the submissions belongs. */
     formId: string;
 }
 export {};

package/build/cjs/src/forms-v4-submission.universal.js

@@ -146,8 +146,8 @@ function createSubmission(submission, options) {
 }
 exports.createSubmission = createSubmission;
 /**
- * Gets a submission by id.
- * @param submissionId - Id of the submission to retrieve.
+ * Retrieves a submission by ID.
+ * @param submissionId - ID of the submission to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
@@ -198,8 +198,9 @@ function getSubmission(submissionId) {
 }
 exports.getSubmission = getSubmission;
 /**
- * Updates a submission, supports partial update.
- * You need to pass the latest 'revision' for a successful update.
+ * Updates a submission.
+ *
+ * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
  * @param _id - Form submission ID.
  * @public
  * @documentationMaturity preview
@@ -255,8 +256,12 @@ function updateSubmission(_id, submission) {
 }
 exports.updateSubmission = updateSubmission;
 /**
- * Change submission status to 'CONFIRMED'
- * @param submissionId - Submission id.
+ * Confirms a submission and changes the submission status to `CONFIRMED`.
+ *
+ *
+ * You can only confirm a submission that has a `PENDING` status.
+ * Currently, the default status when a submission is created is `CONFIRMED`. You can override the default status when using the [Create Submission](#) endpoints. change the status of a submission using the [`Update Submission`](#) endpoints. The ability to set the default status to `PENDING` will be availbe using the upcoming Form Submissions SPI.
+ * @param submissionId - Submission IDs.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
@@ -306,8 +311,8 @@ function confirmSubmission(submissionId) {
 }
 exports.confirmSubmission = confirmSubmission;
 /**
- * Deletes a submission.
- * @param submissionId - Id of the submission to delete.
+ * Deletes a submission by ID.
+ * @param submissionId - ID of the submission to be deleted.
  * @public
  * @documentationMaturity preview
  * @requiredField submissionId
@@ -357,7 +362,14 @@ function deleteSubmission(submissionId) {
 }
 exports.deleteSubmission = deleteSubmission;
 /**
- * Query submissions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
+ *
+ *
+ * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
+ *
+ * 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
+ *
+ * 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).
  * @public
  * @documentationMaturity preview
  */
@@ -414,7 +426,7 @@ function querySubmission(options) {
 }
 exports.querySubmission = querySubmission;
 /**
- * Counts forms submissions.
+ * Counts ths submissions beloning to the specified forms.
  * @param formIds - Form IDs.
  * @public
  * @documentationMaturity preview
@@ -471,8 +483,9 @@ function countSubmissions(formIds, options) {
 }
 exports.countSubmissions = countSubmissions;
 /**
+ * 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.
  * Returns url to upload media file.
- * @param formId - Form id.
+ * @param formId - Form ID.
  * @public
  * @documentationMaturity preview
  * @requiredField formId
@@ -532,8 +545,8 @@ function getMediaUploadUrl(formId, options) {
 }
 exports.getMediaUploadUrl = getMediaUploadUrl;
 /**
- * Marks submissions as seen.
- * @param ids - Submission ids to mark as seen.
+ * Marks form submissions as seen.
+ * @param ids - Submission IDs to mark as seen.
  * @public
  * @documentationMaturity preview
  * @requiredField ids