import { RequestOptionsFactory } from '@wix/sdk-types'; /** * Creates a submission. * * * The `createSubmission()` function is an alternative way to the [`WixFormsV2`](https://www.wix.com/velo/reference/$w/wixformsv2/submit) element for submitting a form. In this case, clicking the submit button is unnecessary, the submission is automatically created when calling this function. */ export declare function createSubmission(payload: object): RequestOptionsFactory; /** * Creates multiple submissions with specified submitters. * Internal, migration only. */ export declare function bulkCreateSubmissionBySubmitter(payload: object): RequestOptionsFactory; /** Retrieves a submission by ID. */ export declare function getSubmission(payload: object): RequestOptionsFactory; /** * 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: object): RequestOptionsFactory; /** * Confirms a submission. * * * You can only confirm a submission that has a `PENDING` status. * When using forms from the [Wix Pricing Plans](https://www.wix.com/app-market/paid-plans?referral=collection&appIndex=42&referralTag=made-by-wix&referralSectionName=made-by-wix) app, the default submission status is `PENDING`. * When using forms from the [Wix Forms]() app, the default form submission status is `CONFIRMED`. You can change the default status for individual submissions using the `updateSubmission()` method. */ export declare function confirmSubmission(payload: object): RequestOptionsFactory; /** * Deletes a submission. * * * This function moves the form submission into the trash bin. To delete the submission permanently, change the default `permanent` field value to `true.` */ export declare function deleteSubmission(payload: object): RequestOptionsFactory; /** Deletes submissions by IDS for specific form. */ export declare function bulkDeleteSubmission(payload: object): RequestOptionsFactory; /** Restores deleted submission */ export declare function restoreSubmissionFromTrashBin(payload: object): RequestOptionsFactory; /** Remove deleted submission */ export declare function removeSubmissionFromTrashBin(payload: object): RequestOptionsFactory; /** Remove multiple deleted submissions */ export declare function bulkRemoveSubmissionFromTrashBin(payload: object): RequestOptionsFactory; /** List deleted submissions */ export declare function listDeletedSubmissions(payload: object): RequestOptionsFactory; /** Get deleted submission */ export declare function getDeletedSubmission(payload: object): RequestOptionsFactory; /** * Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace. * @deprecated It has been replaced with com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace(), and will be removed on 2025-04-01. */ export declare function querySubmission(payload: object): RequestOptionsFactory; /** * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site. *
* * 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/wix-forms/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 searchSubmissionsByNamespace(payload: object): RequestOptionsFactory; /** * Creates a query to retrieve a list of submissions. * * * The `querySubmissionsByNamespace()` method builds a query to retrieve a list of submissions from the specified namespace and returns a [`SubmissionsQueryBuilder`](#submissionsquerybuilder) object. * >**Note:** You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error. * * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#submissionsquerybuilder/find) method. * * You can refine the query by chaining `SubmissionsQueryBuilder` methods onto the query. `SubmissionsQueryBuilder` methods enable you to sort, filter, and control the results that `querySubmissionsByNamespace()` returns. * * The following `SubmissionsQueryBuilder` methods are supported for `querySubmissionsByNamespace()`. For a full description of the Submissions object, see the object returned for the [`items`](#submissionsqueryresult/items) property in [`SubmissionsQueryResult`](#submissionsqueryresult). */ export declare function querySubmissionsByNamespace(payload: object): RequestOptionsFactory; /** * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site. *
* Counts the number of submissions belonging to forms that were filtered and contain a provided expression. */ export declare function countSubmissionsByFilter(payload: object): RequestOptionsFactory; /** * Counts the number of submissions belonging to the specified forms. * * * The `countSubmissions()` function is useful for analytics and tracking purposes. For example, if you have a contact form on your website, you can use this function to track how many submissions it receives daily, weekly, or monthly. */ export declare function countSubmissions(payload: object): RequestOptionsFactory; /** * > **Note:** * > The Submissions API is only available in the Wix Studio editor. * * Counts the number of submissions belonging to the specified forms. */ export declare function countDeletedSubmissions(payload: object): RequestOptionsFactory; /** * Retrieves a URL generated by the [Media Manager](https://www.wix.com/velo/reference/wix-media-v2/files/generatefileuploadurl) to use when creating a submission that includes a field for uploading files. * > **Note:** You need at least a [Standard Premium](https://support.wix.com/en/article/choosing-a-premium-plan) plan for your site to upload files. * * * To learn how external clients can use the generated upload URL to upload a file to the Media Manager, see [Upload API](https://www.wix.com/velo/reference/wix-media-v2/files/upload-api). */ export declare function getMediaUploadUrl(payload: object): RequestOptionsFactory; /** * Marks form submissions as "seen". * * * This function marks the submissions as if they were seen by the site owner. Only site collaborators with the **[Manage Submission](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions)** permissions can mark submissions. */ export declare function bulkMarkSubmissionsAsSeen(payload: object): RequestOptionsFactory; /** Gets submission as document which may include the document download url if the document is ready. */ export declare function getSubmissionDownloadUrl(payload: object): RequestOptionsFactory; /** Update Extended Fields of the Form */ export declare function updateExtendedFields(payload: object): RequestOptionsFactory; /** Upserts contact from submission. */ export declare function upsertContactFromSubmission(payload: object): RequestOptionsFactory;