@wix/auto_sdk_forms_submissions 1.0.27 → 1.0.28

package/build/internal/cjs/meta.d.ts

@@ -1 +1,1043 @@
-export * from './src/forms-v4-submission-submissions.meta.js';
+import { gP as UpsertContactFromSubmissionRequest$1, a as UpsertContactFromSubmissionResponse$1, gR as CreateSubmissionRequest$1, gS as CreateSubmissionResponse$1, h4 as GetSubmissionRequest$1, h5 as GetSubmissionResponse$1, h8 as UpdateSubmissionRequest$1, h9 as UpdateSubmissionResponse$1, ha as ConfirmSubmissionRequest$1, f as ConfirmSubmissionResponse$1, hb as DeleteSubmissionRequest$1, hc as DeleteSubmissionResponse$1, hd as BulkDeleteSubmissionRequest$1, g as BulkDeleteSubmissionResponse$1, hf as RestoreSubmissionFromTrashBinRequest$1, R as RestoreSubmissionFromTrashBinResponse$1, hg as RemoveSubmissionFromTrashBinRequest$1, hh as RemoveSubmissionFromTrashBinResponse$1, hi as BulkRemoveSubmissionFromTrashBinRequest$1, i as BulkRemoveSubmissionFromTrashBinResponse$1, hk as ListDeletedSubmissionsRequest$1, j as ListDeletedSubmissionsResponse$1, ho as GetDeletedSubmissionRequest$1, G as GetDeletedSubmissionResponse$1, hp as QuerySubmissionRequest$1, l as QuerySubmissionResponse$1, hs as SearchSubmissionsByNamespaceRequest$1, S as SearchSubmissionsByNamespaceResponse$1, hy as QuerySubmissionsByNamespaceRequest$1, hz as QuerySubmissionsByNamespaceResponse$1, hC as CountSubmissionsByFilterRequest$1, q as CountSubmissionsByFilterResponse$1, hE as CountSubmissionsRequest$1, s as CountSubmissionsResponse$1, hF as CountDeletedSubmissionsRequest$1, u as CountDeletedSubmissionsResponse$1, hH as GetMediaUploadURLRequest$1, v as GetMediaUploadURLResponse$1, hI as BulkMarkSubmissionsAsSeenRequest$1, hJ as BulkMarkSubmissionsAsSeenResponse$1, hK as GetSubmissionDownloadUrlRequest$1, w as GetSubmissionDownloadUrlResponse$1, hO as GetFormattedSubmissionRequest$1, x as GetFormattedSubmissionResponse$1, hT as UpdateExtendedFieldsRequest$1, z as UpdateExtendedFieldsResponse$1, hU as BulkUpdateFormSubmissionTagsRequest$1, E as BulkUpdateFormSubmissionTagsResponse$1, hW as BulkUpdateFormSubmissionTagsByFilterRequest$1, I as BulkUpdateFormSubmissionTagsByFilterResponse$1, hX as ValidateFormSubmissionRequest$1, J as ValidateFormSubmissionResponse$1 } from './forms-v4-submission-submissions.universal-ILKHqisa.js';
+import '@wix/sdk-types';
+
+/** Form submission that was created or retrieved. */
+interface FormSubmission {
+    /**
+     * Submission ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * ID of the form which the submission belongs to.
+     * @format GUID
+     * @immutable
+     */
+    formId?: string;
+    /**
+     * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.
+     * @minLength 10
+     * @maxLength 50
+     * @readonly
+     */
+    namespace?: string;
+    /** Status of the submission. */
+    status?: SubmissionStatusWithLiterals;
+    /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
+    submissions?: Record<string, any>;
+    /**
+     * Date and time the form submission was created.
+     * @immutable
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the form submission was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * ID of the visitor that submitted the form.
+     * @readonly
+     */
+    submitter?: Submitter;
+    /** Whether a site owner marked a submission as "seen". */
+    seen?: boolean;
+    /** Data extension object that holds users' and apps' fields. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Order details. <br>
+     * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
+     */
+    orderDetails?: OrderDetails;
+    /**
+     * Contact ID of a site visitor who created the submission.
+     * @format GUID
+     * @immutable
+     */
+    contactId?: string | null;
+    /**
+     * Authorized viewer ID.
+     * @format GUID
+     * @immutable
+     */
+    accessRestriction?: string | null;
+    /** Tag IDs collections associated with the current entity. */
+    tags?: PublicTags;
+}
+declare enum SubmissionStatus {
+    UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
+    /** A submission is created, but has not yet been recorded in the Wix Forms collection. */
+    PENDING = "PENDING",
+    /** A submission is recorded in the Wix Forms collection. */
+    CONFIRMED = "CONFIRMED",
+    /** A form submission requiring payment is created. */
+    PAYMENT_WAITING = "PAYMENT_WAITING",
+    /** An order of a form submission is canceled. */
+    PAYMENT_CANCELED = "PAYMENT_CANCELED"
+}
+/** @enumType */
+type SubmissionStatusWithLiterals = SubmissionStatus | 'UNKNOWN_SUBMISSION_STATUS' | 'PENDING' | 'CONFIRMED' | 'PAYMENT_WAITING' | 'PAYMENT_CANCELED';
+interface Submitter extends SubmitterSubmitterOneOf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
+    visitorId?: string | null;
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
+    applicationId?: string | null;
+    /**
+     * User ID.
+     * @format GUID
+     */
+    userId?: string | null;
+}
+/** @oneof */
+interface SubmitterSubmitterOneOf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
+    visitorId?: string | null;
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
+    applicationId?: string | null;
+    /**
+     * User ID.
+     * @format GUID
+     */
+    userId?: string | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface OrderDetails {
+    /**
+     * ID of the order related to submission (only applicable if a form has payments).
+     * @format GUID
+     * @readonly
+     */
+    orderId?: string | null;
+    /**
+     * Order number.
+     * @readonly
+     */
+    number?: string | null;
+    /**
+     * Currency.
+     * @format CURRENCY
+     * @readonly
+     */
+    currency?: string | null;
+    /**
+     * Item subtotal.
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     * @readonly
+     */
+    itemSubtotal?: string;
+    /**
+     * ID of the checkout related to submission (only applicable if a form has payments).
+     * @format GUID
+     * @readonly
+     */
+    checkoutId?: string;
+}
+interface PublicTags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface UpsertContactFromSubmissionRequest {
+    /**
+     * Submission from which contact needs to be upserted.
+     * @format GUID
+     */
+    submissionId: string;
+    /**
+     * Optional contact id to which submission should be mapped.
+     * @format GUID
+     */
+    contactId?: string | null;
+    /** Indicates contact has verified primary email. */
+    emailVerified?: boolean;
+}
+interface UpsertContactFromSubmissionResponse {
+    /** Submit contact response. */
+    submitContactResponse?: SubmitContactResponse;
+}
+interface SubmitContactResponse {
+    /**
+     * ID of the contact that was found or created.
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Identity type of the returned contact.
+     *
+     * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
+     * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
+     * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
+     */
+    identityType?: IdentityTypeWithLiterals;
+    /**
+     * Indicates whether the contact was just created or already existed.
+     *
+     * If the contact was just created, returns `true`.
+     * If it already existed, returns `false`.
+     */
+    newContact?: boolean;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    /** Existing or new contact */
+    CONTACT = "CONTACT",
+    /** Member is logged in, matching logic skipped */
+    MEMBER = "MEMBER",
+    /** Matching contact is a member, Merge logic won't be applied */
+    NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'CONTACT' | 'MEMBER' | 'NOT_AUTHENTICATED_MEMBER';
+interface CreateSubmissionRequest {
+    /** Submission to create. */
+    submission: FormSubmission;
+    /**
+     * Captcha token.
+     * @minLength 1
+     * @maxLength 3000
+     */
+    captchaToken?: string | null;
+}
+interface CreateSubmissionResponse {
+    /** The created submission. */
+    submission?: FormSubmission;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface GetSubmissionRequest {
+    /**
+     * ID of the submission to retrieve.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface GetSubmissionResponse {
+    /** The retrieved submission. */
+    submission?: FormSubmission;
+}
+interface UpdateSubmissionRequest {
+    /** Submission to update. */
+    submission: FormSubmission;
+}
+interface UpdateSubmissionResponse {
+    /** The updated submission. */
+    submission?: FormSubmission;
+}
+interface ConfirmSubmissionRequest {
+    /**
+     * Submission ID to confirm.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface ConfirmSubmissionResponse {
+    /** The confirmed submission. */
+    submission?: FormSubmission;
+}
+interface DeleteSubmissionRequest {
+    /**
+     * ID of the submission to delete.
+     * @format GUID
+     */
+    submissionId: string;
+    /**
+     * Whether to permanently delete a submission bypassing the trash bin.
+     *
+     * Default: `false`
+     */
+    permanent?: boolean;
+    /** Whether to preserve files, associated with the submission. If the value is `false`, then the files are deleted after 210 days. */
+    preserveFiles?: boolean;
+}
+interface DeleteSubmissionResponse {
+}
+interface BulkDeleteSubmissionRequest {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * Submission ids.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    submissionIds?: string[];
+    /**
+     * Delete submission bypassing trash-bin
+     * Default: false
+     */
+    permanent?: boolean;
+    /** Preserve files. */
+    preserveFiles?: boolean;
+}
+interface BulkDeleteSubmissionResponse {
+    /**
+     * Results of bulk submission delete
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteSubmissionResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteSubmissionResult {
+    /** Deleted item metadata */
+    itemMetadata?: ItemMetadata;
+}
+interface RestoreSubmissionFromTrashBinRequest {
+    /**
+     * ID of the submission to restore.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface RestoreSubmissionFromTrashBinResponse {
+    /** The restored submission. */
+    submission?: FormSubmission;
+}
+interface RemoveSubmissionFromTrashBinRequest {
+    /**
+     * ID of the submission to restore.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface RemoveSubmissionFromTrashBinResponse {
+}
+interface BulkRemoveSubmissionFromTrashBinRequest {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * Submission ids.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    submissionIds?: string[];
+}
+interface BulkRemoveSubmissionFromTrashBinResponse {
+    /**
+     * Results of bulk submission removal from trash
+     * @maxSize 100
+     */
+    results?: BulkRemoveSubmissionFromTrashBinResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkRemoveSubmissionFromTrashBinResult {
+    /** Deleted item metadata */
+    itemMetadata?: ItemMetadata;
+}
+interface ListDeletedSubmissionsRequest {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * Submission ids.
+     * @maxSize 10
+     * @format GUID
+     */
+    submissionIds?: string[];
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
+    paging?: CursorPaging;
+    /**
+     * List of statuses of submissions which should be returned
+     * Default: CONFIRMED
+     * @maxSize 4
+     */
+    statuses?: SubmissionStatusWithLiterals[];
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListDeletedSubmissionsResponse {
+    /** The retrieved Submissions. */
+    submissions?: FormSubmission[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor pointing to next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface GetDeletedSubmissionRequest {
+    /**
+     * Submission id.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface GetDeletedSubmissionResponse {
+    /** The retrieved Submission. */
+    submission?: FormSubmission;
+}
+interface QuerySubmissionRequest {
+    /** Query options. */
+    query: CursorQuery;
+    /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
+    onlyYourOwn?: boolean;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 3
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface QuerySubmissionResponse {
+    /** The retrieved submissions. */
+    submissions?: FormSubmission[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface SearchSubmissionsByNamespaceRequest {
+    /** Query options. */
+    search: CursorSearch;
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
+    cursorPaging?: CursorPaging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /** Free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
+    cursorPaging?: CursorPaging;
+}
+interface SearchDetails {
+    /** Defines how separate search terms in `expression` are combined */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** Any of the search terms must be present */
+    OR = "OR",
+    /** All search terms must be present */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+interface SearchSubmissionsByNamespaceResponse {
+    /** The retrieved Submissions. */
+    submissions?: FormSubmission[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface QuerySubmissionsByNamespaceRequest {
+    /** Query options. */
+    query: CursorQuery;
+    /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
+    onlyYourOwn?: boolean;
+}
+interface QuerySubmissionsByNamespaceResponse {
+    /** The retrieved Submissions. */
+    submissions?: FormSubmission[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+interface CountSubmissionsByFilterRequest {
+    /** A filter object. Must filter by namespace. */
+    filter: Record<string, any> | null;
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+}
+interface CountSubmissionsByFilterResponse {
+    /** Forms submission count. */
+    formsSubmissionsCount?: FormSubmissionsCount[];
+}
+interface FormSubmissionsCount {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId?: string;
+    /** Total number of submissions. */
+    totalCount?: number;
+    /** Number of submissions that haven't yet been seen by site Extensions with manage submission permissions. */
+    unseenCount?: number;
+}
+interface CountSubmissionsRequest {
+    /**
+     * Form IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    formIds: string[];
+    /**
+     * 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.
+     * @minLength 10
+     * @maxLength 50
+     */
+    namespace: string;
+    /**
+     * List of statuses of submissions which should be taken into count
+     * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
+     * @maxSize 4
+     */
+    statuses?: SubmissionStatusWithLiterals[];
+}
+interface CountSubmissionsResponse {
+    /** Forms submission count. */
+    formsSubmissionsCount?: FormSubmissionsCount[];
+}
+interface CountDeletedSubmissionsRequest {
+    /**
+     * Form IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    formIds: string[];
+    /**
+     * 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.
+     * @minLength 10
+     * @maxLength 50
+     */
+    namespace: string;
+    /**
+     * List of statuses of submissions which should be taken into count
+     * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
+     * @maxSize 4
+     */
+    statuses?: SubmissionStatusWithLiterals[];
+}
+interface CountDeletedSubmissionsResponse {
+    /** Forms submission count. */
+    formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
+}
+interface FormDeletedSubmissionsCount {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId?: string;
+    /** Total number of submissions. */
+    totalCount?: number;
+}
+interface GetMediaUploadURLRequest {
+    /**
+     * Form ID.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * Name of file to upload.
+     * @maxLength 300
+     */
+    filename: string;
+    /**
+     * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
+     *
+     * For example, `'image/png'`
+     * @maxLength 100
+     */
+    mimeType: string;
+}
+interface GetMediaUploadURLResponse {
+    /**
+     * Url to upload file.
+     * @maxLength 500
+     */
+    uploadUrl?: string;
+}
+interface BulkMarkSubmissionsAsSeenRequest {
+    /**
+     * Submission IDs to mark as seen.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    ids: string[];
+    /**
+     * ID of the form which the submissions belongs to.
+     * @format GUID
+     */
+    formId: string;
+}
+interface BulkMarkSubmissionsAsSeenResponse {
+}
+interface GetSubmissionDownloadUrlRequest {
+    /**
+     * Submission ID.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface GetSubmissionDownloadUrlResponse {
+    /** The retrieved submission document. */
+    document?: SubmissionDocument;
+}
+interface SubmissionDocument extends SubmissionDocumentDocumentOneOf {
+    /** Data of ready to download document */
+    readyDetails?: DocumentReady;
+    /**
+     * Document ID.
+     * @readonly
+     * @maxLength 50
+     */
+    id?: string | null;
+    /** Document status. */
+    status?: StatusWithLiterals;
+}
+/** @oneof */
+interface SubmissionDocumentDocumentOneOf {
+    /** Data of ready to download document */
+    readyDetails?: DocumentReady;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    READY = "READY",
+    PENDING = "PENDING",
+    FAILED = "FAILED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'READY' | 'PENDING' | 'FAILED';
+interface DocumentReady {
+    /**
+     * Document download URL.
+     * @readonly
+     * @maxLength 300
+     */
+    downloadUrl?: string;
+}
+interface GetFormattedSubmissionRequest {
+    /**
+     * Submission ID.
+     * @format GUID
+     */
+    submissionId: string;
+}
+interface GetFormattedSubmissionResponse {
+    /**
+     * Submission ID.
+     * @format GUID
+     */
+    submissionId?: string;
+    /**
+     * Ordered by form layout list of field submissions.
+     * @maxSize 100
+     */
+    submissions?: FormattedSubmission[];
+}
+interface FormattedSubmission {
+    /**
+     * Label of form field
+     * @maxLength 500
+     */
+    label?: string | null;
+    /**
+     * Key of the submission, and target of a form field
+     * @maxLength 200
+     */
+    key?: string;
+    /**
+     * Value of the submission, formatted as a string
+     * @maxLength 500
+     */
+    value?: string;
+    /**
+     * Id of the form field
+     * @format GUID
+     */
+    fieldId?: string;
+}
+interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+interface UpdateExtendedFieldsResponse {
+    /**
+     * namespace that was updated
+     * @minLength 10
+     * @maxLength 50
+     */
+    namespace?: string;
+    /** only data from UpdateExtendedFieldsRequest namespace_data */
+    namespaceData?: Record<string, any> | null;
+}
+interface BulkUpdateFormSubmissionTagsRequest {
+    /**
+     * Submission IDs to update tags for.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    submissionIds: string[];
+    /** Tags to be added to submissions */
+    assignTags?: PublicTags;
+    /** Tags to be removed from submissions */
+    unassignTags?: PublicTags;
+}
+interface BulkUpdateFormSubmissionTagsResponse {
+    /**
+     * Updated submissions with results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateFormSubmissionTagsResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateFormSubmissionTagsResult {
+    /** Updated item metadata */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdateFormSubmissionTagsByFilterRequest {
+    /** Filter to select the submission to update */
+    filter: Record<string, any> | null;
+    /** Tags to be added to submissions */
+    assignTags?: PublicTags;
+    /** Tags to be removed from submissions */
+    unassignTags?: PublicTags;
+}
+interface BulkUpdateFormSubmissionTagsByFilterResponse {
+    /**
+     * Job id for the bulk update operation
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface ValidateFormSubmissionRequest {
+    /** Submission to validate. */
+    submission: FormSubmission;
+    /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
+    additionalMetadata?: Record<string, any> | null;
+    /**
+     * List of field targets/keys to validate, in case when only several fields should to be validated.
+     * If empty, all form fields be validated
+     * @maxSize 200
+     * @maxLength 200
+     */
+    fieldsToValidate?: string[];
+}
+interface ValidateFormSubmissionResponse {
+    /**
+     * Flag indicating if the submission is valid
+     * Default: true
+     */
+    valid?: boolean | null;
+    /**
+     * Submission validation violations
+     * @maxSize 100
+     */
+    violationErrors?: FieldViolation[];
+}
+interface FieldViolation extends FieldViolationErrorDataOneOf {
+    /** Validation errors */
+    submissionValidationErrors?: SubmissionValidationErrors;
+    /**
+     * Name of violated entity
+     * @maxLength 50
+     */
+    name?: string;
+    /**
+     * Description of the error
+     * @maxLength 512
+     */
+    description?: string;
+    /**
+     * Rule name
+     * @maxLength 50
+     */
+    ruleName?: string;
+}
+/** @oneof */
+interface FieldViolationErrorDataOneOf {
+    /** Validation errors */
+    submissionValidationErrors?: SubmissionValidationErrors;
+}
+interface SubmissionValidationErrors {
+    /**
+     * Submission validation errors.
+     * @maxSize 100
+     */
+    errors?: SubmissionValidationError[];
+}
+interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
+    /** Predefined error type. */
+    errorType?: SubmissionErrorTypeWithLiterals;
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
+    customErrorMessage?: string;
+    /**
+     * Path indicating the source of the error, such as `form.fields.target`.
+     * @maxLength 500
+     */
+    errorPath?: string;
+    /** Additional error parameters. */
+    params?: Record<string, any> | null;
+}
+/** @oneof */
+interface SubmissionValidationErrorErrorMessageOneOf {
+    /** Predefined error type. */
+    errorType?: SubmissionErrorTypeWithLiterals;
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
+    customErrorMessage?: string;
+}
+declare enum SubmissionErrorType {
+    /** Error is unknown or unsuitable for any of the options below. */
+    UNKNOWN_ERROR = "UNKNOWN_ERROR",
+    /** Type of submitted value is incorrect. */
+    TYPE_ERROR = "TYPE_ERROR",
+    /** Value is required to be provided. */
+    REQUIRED_VALUE_ERROR = "REQUIRED_VALUE_ERROR",
+    /** Value contains additional properties not expected in schema. */
+    UNKNOWN_VALUE_ERROR = "UNKNOWN_VALUE_ERROR",
+    /** Text value exceeds max length. */
+    MAX_LENGTH_ERROR = "MAX_LENGTH_ERROR",
+    /** Text value does not reach min length. */
+    MIN_LENGTH_ERROR = "MIN_LENGTH_ERROR",
+    /** Text value is not applicable for expected pattern. */
+    PATTERN_ERROR = "PATTERN_ERROR",
+    /** Text value is not applicable for expected format. */
+    FORMAT_ERROR = "FORMAT_ERROR",
+    /** Number value is too big. */
+    MAX_VALUE_ERROR = "MAX_VALUE_ERROR",
+    /** Number value is too small. */
+    MIN_VALUE_ERROR = "MIN_VALUE_ERROR",
+    /** Number value is not a multiple of expected number. */
+    MULTIPLE_OF_VALUE_ERROR = "MULTIPLE_OF_VALUE_ERROR",
+    /** Array value has too many items. */
+    MIN_ITEMS_ERROR = "MIN_ITEMS_ERROR",
+    /** Array value has not enough items. */
+    MAX_ITEMS_ERROR = "MAX_ITEMS_ERROR",
+    /** Value is not in the list of allowed values. */
+    NOT_ALLOWED_VALUE_ERROR = "NOT_ALLOWED_VALUE_ERROR",
+    /** Submitted form is disabled. */
+    DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
+}
+/** @enumType */
+type SubmissionErrorTypeWithLiterals = SubmissionErrorType | 'UNKNOWN_ERROR' | 'TYPE_ERROR' | 'REQUIRED_VALUE_ERROR' | 'UNKNOWN_VALUE_ERROR' | 'MAX_LENGTH_ERROR' | 'MIN_LENGTH_ERROR' | 'PATTERN_ERROR' | 'FORMAT_ERROR' | 'MAX_VALUE_ERROR' | 'MIN_VALUE_ERROR' | 'MULTIPLE_OF_VALUE_ERROR' | 'MIN_ITEMS_ERROR' | 'MAX_ITEMS_ERROR' | 'NOT_ALLOWED_VALUE_ERROR' | 'DISABLED_FORM_ERROR';
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function upsertContactFromSubmission(): __PublicMethodMetaInfo<'POST', {}, UpsertContactFromSubmissionRequest$1, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionResponse$1, UpsertContactFromSubmissionResponse>;
+declare function createSubmission(): __PublicMethodMetaInfo<'POST', {}, CreateSubmissionRequest$1, CreateSubmissionRequest, CreateSubmissionResponse$1, CreateSubmissionResponse>;
+declare function getSubmission(): __PublicMethodMetaInfo<'GET', {
+    submissionId: string;
+}, GetSubmissionRequest$1, GetSubmissionRequest, GetSubmissionResponse$1, GetSubmissionResponse>;
+declare function updateSubmission(): __PublicMethodMetaInfo<'PATCH', {
+    submissionId: string;
+}, UpdateSubmissionRequest$1, UpdateSubmissionRequest, UpdateSubmissionResponse$1, UpdateSubmissionResponse>;
+declare function confirmSubmission(): __PublicMethodMetaInfo<'POST', {
+    submissionId: string;
+}, ConfirmSubmissionRequest$1, ConfirmSubmissionRequest, ConfirmSubmissionResponse$1, ConfirmSubmissionResponse>;
+declare function deleteSubmission(): __PublicMethodMetaInfo<'DELETE', {
+    submissionId: string;
+}, DeleteSubmissionRequest$1, DeleteSubmissionRequest, DeleteSubmissionResponse$1, DeleteSubmissionResponse>;
+declare function bulkDeleteSubmission(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteSubmissionRequest$1, BulkDeleteSubmissionRequest, BulkDeleteSubmissionResponse$1, BulkDeleteSubmissionResponse>;
+declare function restoreSubmissionFromTrashBin(): __PublicMethodMetaInfo<'POST', {
+    submissionId: string;
+}, RestoreSubmissionFromTrashBinRequest$1, RestoreSubmissionFromTrashBinRequest, RestoreSubmissionFromTrashBinResponse$1, RestoreSubmissionFromTrashBinResponse>;
+declare function removeSubmissionFromTrashBin(): __PublicMethodMetaInfo<'DELETE', {
+    submissionId: string;
+}, RemoveSubmissionFromTrashBinRequest$1, RemoveSubmissionFromTrashBinRequest, RemoveSubmissionFromTrashBinResponse$1, RemoveSubmissionFromTrashBinResponse>;
+declare function bulkRemoveSubmissionFromTrashBin(): __PublicMethodMetaInfo<'POST', {}, BulkRemoveSubmissionFromTrashBinRequest$1, BulkRemoveSubmissionFromTrashBinRequest, BulkRemoveSubmissionFromTrashBinResponse$1, BulkRemoveSubmissionFromTrashBinResponse>;
+declare function listDeletedSubmissions(): __PublicMethodMetaInfo<'GET', {}, ListDeletedSubmissionsRequest$1, ListDeletedSubmissionsRequest, ListDeletedSubmissionsResponse$1, ListDeletedSubmissionsResponse>;
+declare function getDeletedSubmission(): __PublicMethodMetaInfo<'GET', {
+    submissionId: string;
+}, GetDeletedSubmissionRequest$1, GetDeletedSubmissionRequest, GetDeletedSubmissionResponse$1, GetDeletedSubmissionResponse>;
+declare function querySubmission(): __PublicMethodMetaInfo<'POST', {}, QuerySubmissionRequest$1, QuerySubmissionRequest, QuerySubmissionResponse$1, QuerySubmissionResponse>;
+declare function searchSubmissionsByNamespace(): __PublicMethodMetaInfo<'POST', {}, SearchSubmissionsByNamespaceRequest$1, SearchSubmissionsByNamespaceRequest, SearchSubmissionsByNamespaceResponse$1, SearchSubmissionsByNamespaceResponse>;
+declare function querySubmissionsByNamespace(): __PublicMethodMetaInfo<'POST', {}, QuerySubmissionsByNamespaceRequest$1, QuerySubmissionsByNamespaceRequest, QuerySubmissionsByNamespaceResponse$1, QuerySubmissionsByNamespaceResponse>;
+declare function countSubmissionsByFilter(): __PublicMethodMetaInfo<'POST', {}, CountSubmissionsByFilterRequest$1, CountSubmissionsByFilterRequest, CountSubmissionsByFilterResponse$1, CountSubmissionsByFilterResponse>;
+declare function countSubmissions(): __PublicMethodMetaInfo<'POST', {}, CountSubmissionsRequest$1, CountSubmissionsRequest, CountSubmissionsResponse$1, CountSubmissionsResponse>;
+declare function countDeletedSubmissions(): __PublicMethodMetaInfo<'POST', {}, CountDeletedSubmissionsRequest$1, CountDeletedSubmissionsRequest, CountDeletedSubmissionsResponse$1, CountDeletedSubmissionsResponse>;
+declare function getMediaUploadUrl(): __PublicMethodMetaInfo<'POST', {}, GetMediaUploadURLRequest$1, GetMediaUploadURLRequest, GetMediaUploadURLResponse$1, GetMediaUploadURLResponse>;
+declare function bulkMarkSubmissionsAsSeen(): __PublicMethodMetaInfo<'POST', {}, BulkMarkSubmissionsAsSeenRequest$1, BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse$1, BulkMarkSubmissionsAsSeenResponse>;
+declare function getSubmissionDownloadUrl(): __PublicMethodMetaInfo<'GET', {
+    submissionId: string;
+}, GetSubmissionDownloadUrlRequest$1, GetSubmissionDownloadUrlRequest, GetSubmissionDownloadUrlResponse$1, GetSubmissionDownloadUrlResponse>;
+declare function getFormattedSubmission(): __PublicMethodMetaInfo<'GET', {
+    submissionId: string;
+}, GetFormattedSubmissionRequest$1, GetFormattedSubmissionRequest, GetFormattedSubmissionResponse$1, GetFormattedSubmissionResponse>;
+declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>;
+declare function bulkUpdateFormSubmissionTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateFormSubmissionTagsRequest$1, BulkUpdateFormSubmissionTagsRequest, BulkUpdateFormSubmissionTagsResponse$1, BulkUpdateFormSubmissionTagsResponse>;
+declare function bulkUpdateFormSubmissionTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateFormSubmissionTagsByFilterRequest$1, BulkUpdateFormSubmissionTagsByFilterRequest, BulkUpdateFormSubmissionTagsByFilterResponse$1, BulkUpdateFormSubmissionTagsByFilterResponse>;
+declare function validateFormSubmission(): __PublicMethodMetaInfo<'POST', {}, ValidateFormSubmissionRequest$1, ValidateFormSubmissionRequest, ValidateFormSubmissionResponse$1, ValidateFormSubmissionResponse>;
+
+export { type __PublicMethodMetaInfo, bulkDeleteSubmission, bulkMarkSubmissionsAsSeen, bulkRemoveSubmissionFromTrashBin, bulkUpdateFormSubmissionTags, bulkUpdateFormSubmissionTagsByFilter, confirmSubmission, countDeletedSubmissions, countSubmissions, countSubmissionsByFilter, createSubmission, deleteSubmission, getDeletedSubmission, getFormattedSubmission, getMediaUploadUrl, getSubmission, getSubmissionDownloadUrl, listDeletedSubmissions, querySubmission, querySubmissionsByNamespace, removeSubmissionFromTrashBin, restoreSubmissionFromTrashBin, searchSubmissionsByNamespace, updateExtendedFields, updateSubmission, upsertContactFromSubmission, validateFormSubmission };