@wix/auto_sdk_forms_form-spam-submission-reports 1.0.0

package/build/cjs/src/forms-v4-form-spam-submission-report-form-spam-submission-reports.universal.d.ts

@@ -0,0 +1,973 @@
+/**
+ * FormSpamSubmissionReportReport stores a form submission spam report.
+ * It contains submission details as well as report reason.
+ */
+export interface FormSpamSubmissionReport {
+    /**
+     * Form spam submission report id.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Id of a form to which the form spam submission report belongs. */
+    formId?: string;
+    /**
+     * Form namespace to which the form spam submission report belongs.
+     * @readonly
+     */
+    namespace?: string;
+    /** Form submission submitter id. */
+    submitter?: Submitter;
+    /** Submission values where key is a target of a form field and value is a submissions for the given field. */
+    submissions?: Record<string, any>;
+    /** Identifies the reason why the submission was reported as spam. */
+    reportReason?: ReportReason;
+    /** Date of submission creation. If a submission was created in the past, pass the original submission creation date. */
+    _createdDate?: Date | null;
+    /**
+     * Date of form spam submission report creation.
+     * @readonly
+     */
+    reportedDate?: Date | null;
+    /**
+     * Date of last update.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Data extensions ExtendedFields. */
+    extendedFields?: ExtendedFields;
+    /** Last status of the submission at the time of the report */
+    submissionStatusAtReport?: SubmissionStatus;
+    /** Order details. */
+    orderDetails?: OrderDetails;
+    /**
+     * Contact ID. Member who created the submission, or a mapped contact.
+     * @readonly
+     */
+    contactId?: string | null;
+    /** authorized viewer user id */
+    accessRestriction?: string | null;
+}
+export interface Submitter extends SubmitterSubmitterOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Application ID. */
+    applicationId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+}
+/** @oneof */
+export interface SubmitterSubmitterOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Application ID. */
+    applicationId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+}
+export declare enum ReportReason {
+    UNKNOWN_REASON = "UNKNOWN_REASON",
+    /** An email quota is reached. There were too many submissions in a short time period with the same email. */
+    EMAIL_QUOTA_REACHED = "EMAIL_QUOTA_REACHED",
+    /** An IP address is is blocklisted. */
+    IP_BLOCKLISTED = "IP_BLOCKLISTED",
+    /** An email is is blocklisted. */
+    EMAIL_BLOCKLISTED = "EMAIL_BLOCKLISTED",
+    /** Reported spam by the AI spam detection model. It uses submission text as an input. */
+    AI_REPORTED = "AI_REPORTED",
+    /** Reported as spam by a submission manager. */
+    MANUALLY_REPORTED = "MANUALLY_REPORTED"
+}
+export 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>>;
+}
+export 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"
+}
+export interface OrderDetails {
+    /**
+     * ID of the checkout related to submission (applicable if form has payments added).
+     * @readonly
+     */
+    checkoutId?: string;
+}
+export interface CheckForSpamRequest {
+    /** Form submission. */
+    submission: FormSubmission;
+}
+/** Form submission that was created or retrieved. */
+export interface FormSubmission {
+    /**
+     * Submission ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** ID of the form which the submission belongs to. */
+    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.
+     * @readonly
+     */
+    namespace?: string;
+    /** Status of the submission. */
+    status?: SubmissionStatus;
+    /** 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. */
+    _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 submittng a form in the Wix Payments app.
+     */
+    orderDetails?: FormSubmissionOrderDetails;
+    /** Contact ID of a site visitor who created the submission. */
+    contactId?: string | null;
+    /** authorized viewer user id */
+    accessRestriction?: string | null;
+    /** Tag ids collections associated with current entity. */
+    tags?: PublicTags;
+}
+export interface FormSubmissionOrderDetails {
+    /**
+     * ID of the order related to submission (only applicable if a form has payments).
+     * @readonly
+     */
+    orderId?: string | null;
+    /**
+     * Order number.
+     * @readonly
+     */
+    number?: string | null;
+    /**
+     * Currency.
+     * @readonly
+     */
+    currency?: string | null;
+    /**
+     * Item subtotal.
+     * @readonly
+     */
+    itemSubtotal?: string;
+    /**
+     * ID of the checkout related to submission (only applicable if a form has payments).
+     * @readonly
+     */
+    checkoutId?: string;
+}
+export interface PublicTags {
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /** List of tag IDs */
+    tagIds?: string[];
+}
+export interface CheckForSpamResponse {
+    /** Is the submission a spam. */
+    spam?: boolean;
+    /** Spam report details. Filled when spam == true */
+    spamReport?: SpamReport;
+}
+export interface SpamReport {
+    /** Identifies the reason why the submission was reported as spam. */
+    reportReason?: ReportReason;
+}
+export interface CreateFormSpamSubmissionReportRequest {
+    /** Form spam submission report to be created. */
+    formSpamSubmissionReport: FormSpamSubmissionReport;
+}
+export interface CreateFormSpamSubmissionReportResponse {
+    /** The created form spam submission report. */
+    formSpamSubmissionReport?: FormSpamSubmissionReport;
+}
+export interface FormSpamSubmissionReportValidationErrorsDetails {
+    /** Submission validation errors details. */
+    errors?: ValidationError[];
+}
+export interface ValidationError {
+    /** Path indicating the source of the error, such as `submission.submissions.email`` */
+    errorPath?: string;
+    /** Error type. */
+    errorType?: ErrorType;
+    /** Error message. */
+    errorMessage?: string;
+    /** Additional error parameters, to help identify additional info. */
+    params?: Record<string, any> | null;
+    /**
+     * Whether to use a custom error message.
+     * If `false`, the API takes the message from the `errorType` field.
+     * Default: `false`
+     */
+    useCustomErrorMessage?: boolean;
+}
+export declare enum ErrorType {
+    /** Error is unknown or not suitable for any of options bellow */
+    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 not reaches min length */
+    MIN_LENGTH_ERROR = "MIN_LENGTH_ERROR",
+    /** Text value not applicable for expected pattern */
+    PATTERN_ERROR = "PATTERN_ERROR",
+    /** Text value 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 multiple of expected number */
+    MULTIPLE_OF_VALUE_ERROR = "MULTIPLE_OF_VALUE_ERROR",
+    /** Array value has too much items */
+    MIN_ITEMS_ERROR = "MIN_ITEMS_ERROR",
+    /** Array value has not enough items */
+    MAX_ITEMS_ERROR = "MAX_ITEMS_ERROR",
+    /** Value is not in list of allowed values */
+    NOT_ALLOWED_VALUE_ERROR = "NOT_ALLOWED_VALUE_ERROR",
+    /** Form fields are incompatible */
+    FIELDS_COMPATIBILITY_ERROR = "FIELDS_COMPATIBILITY_ERROR",
+    /** Submitted form is disabled */
+    DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR",
+    /** Too much forms */
+    FORMS_COUNT_RESTRICTIONS_ERROR = "FORMS_COUNT_RESTRICTIONS_ERROR",
+    /** Too much fields on form */
+    FIELDS_COUNT_RESTRICTIONS_ERROR = "FIELDS_COUNT_RESTRICTIONS_ERROR",
+    /** Too much steps on forms */
+    STEPS_COUNT_RESTRICTIONS_ERROR = "STEPS_COUNT_RESTRICTIONS_ERROR",
+    /** Too much rules on forms */
+    RULES_COUNT_RESTRICTIONS_ERROR = "RULES_COUNT_RESTRICTIONS_ERROR",
+    /** File upload is not allowed */
+    FILE_UPLOAD_RESTRICTIONS_ERROR = "FILE_UPLOAD_RESTRICTIONS_ERROR",
+    /** Country code is not correct or missing from the phone number */
+    INVALID_PHONE_COUNTRY_CODE_ERROR = "INVALID_PHONE_COUNTRY_CODE_ERROR",
+    /** Invalid staff member ID on appointment */
+    INVALID_STAFF_ID_ERROR = "INVALID_STAFF_ID_ERROR",
+    /** Invalid business location ID on appointment */
+    INVALID_LOCATION_ID_ERROR = "INVALID_LOCATION_ID_ERROR"
+}
+export interface GetFormSpamSubmissionReportRequest {
+    /** Id of the form spam submission report to retrieve. */
+    formSpamSubmissionReportId: string;
+}
+export interface GetFormSpamSubmissionReportResponse {
+    /** The retrieved form spam submission report. */
+    formSpamSubmissionReport?: FormSpamSubmissionReport;
+}
+export interface DeleteFormSpamSubmissionReportRequest {
+    /** Id of the form spam submission report to delete. */
+    formSpamSubmissionReportId: string;
+}
+export interface DeleteFormSpamSubmissionReportResponse {
+}
+export interface BulkDeleteFormSpamSubmissionReportRequest {
+    /** Form ID. */
+    formId: string;
+    /** Ids of the form spam submission reports to delete. */
+    formSpamSubmissionReportIds?: string[];
+}
+export interface BulkDeleteFormSpamSubmissionReportResponse {
+    /** Results of bulk report delete */
+    results?: BulkDeleteFormSpamSubmissionReportResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteFormSpamSubmissionReportResult {
+    /** Deleted item metadata */
+    itemMetadata?: ItemMetadata;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export 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;
+}
+export interface BulkDeleteFormSpamSubmissionReportByFilterRequest {
+    /**
+     * Filter object.
+     *
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+     */
+    filter: Record<string, any> | null;
+}
+export interface BulkDeleteFormSpamSubmissionReportByFilterResponse {
+    /** Job id of bulk delete form submission report by filter job */
+    jobId?: string;
+}
+export interface ReportNotSpamSubmissionRequest {
+    /** Id of the form spam submission report to report as not spam. */
+    formSpamSubmissionReportId: string;
+}
+export interface ReportNotSpamSubmissionResponse {
+    /** Created form submission. */
+    submission?: FormSubmission;
+}
+export interface BulkReportNotSpamSubmissionRequest {
+    /** Id of the form to which belong reports */
+    formId: string;
+    /** Ids of the form spam submission reports to report as not spam. */
+    formSpamSubmissionReportIds?: string[];
+}
+export interface BulkReportNotSpamSubmissionResponse {
+    /** Info whatever report of specific items was successful */
+    results?: BulkReportNotSpamSubmissionResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkReportNotSpamSubmissionResult {
+    /** Metadata of submission, marked as not spam */
+    itemMetadata?: ItemMetadata;
+    /** Id of related report, which was reported as not spam */
+    formSpamSubmissionReportId?: string;
+}
+export interface ReportSpamSubmissionRequest {
+    /** Id of the submission to report as spam. */
+    submissionId: string;
+    /** Identifies the reason why the submission was reported as spam. */
+    reportReason: ReportReason;
+}
+export interface ReportSpamSubmissionResponse {
+    /** Created form spam submission report. */
+    formSpamSubmissionReport?: FormSpamSubmissionReport;
+}
+export interface BulkReportSpamSubmissionRequest {
+    /** Id of the form to which belong submissions to report as spam. */
+    formId: string;
+    /** Ids of the submissions to report as spam. */
+    submissionIds: string[];
+    /** Identifies the reason why the submission was reported as spam. */
+    reportReason: ReportReason;
+    /** When set, items will be returned on successful report */
+    returnEntity?: boolean;
+}
+export interface BulkReportSpamSubmissionResponse {
+    /** Created reports with metadata */
+    results?: BulkReportSpamSubmissionResult[];
+    /** Metadata of request */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkReportSpamSubmissionResult {
+    /** Created report metadata */
+    itemMetadata?: ItemMetadata;
+    /** Created report, exists if `returnEntity` was set to `true` in the request */
+    item?: FormSpamSubmissionReport;
+}
+export interface QueryFormSpamSubmissionReportsByNamespaceRequest {
+    /** WQL expression. */
+    query: CursorQuery;
+}
+export 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"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryFormSpamSubmissionReportsByNamespaceResponse {
+    /** The retrieved FormSpamSubmissionReports. */
+    formSpamSubmissionReports?: FormSpamSubmissionReport[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export 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;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface CountFormSpamSubmissionReportsRequest {
+    /** Form IDs. */
+    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. */
+    namespace: string;
+}
+export interface CountFormSpamSubmissionReportsResponse {
+    /** Forms submission count. */
+    formsSpamSubmissionReportsCount?: FormSpamSubmissionReportsCount[];
+}
+export interface FormSpamSubmissionReportsCount {
+    /** Form ID. */
+    formId?: string;
+    /** Total number of submissions. */
+    totalCount?: number;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface SpamReportNonNullableFields {
+    reportReason: ReportReason;
+}
+export interface CheckForSpamResponseNonNullableFields {
+    spam: boolean;
+    spamReport?: SpamReportNonNullableFields;
+}
+interface OrderDetailsNonNullableFields {
+    checkoutId: string;
+}
+export interface FormSpamSubmissionReportNonNullableFields {
+    formId: string;
+    namespace: string;
+    reportReason: ReportReason;
+    submissionStatusAtReport: SubmissionStatus;
+    orderDetails?: OrderDetailsNonNullableFields;
+}
+export interface CreateFormSpamSubmissionReportResponseNonNullableFields {
+    formSpamSubmissionReport?: FormSpamSubmissionReportNonNullableFields;
+}
+export interface GetFormSpamSubmissionReportResponseNonNullableFields {
+    formSpamSubmissionReport?: FormSpamSubmissionReportNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkDeleteFormSpamSubmissionReportResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkDeleteFormSpamSubmissionReportResponseNonNullableFields {
+    results: BulkDeleteFormSpamSubmissionReportResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkDeleteFormSpamSubmissionReportByFilterResponseNonNullableFields {
+    jobId: string;
+}
+interface FormSubmissionOrderDetailsNonNullableFields {
+    itemSubtotal: string;
+    checkoutId: string;
+}
+interface TagListNonNullableFields {
+    tagIds: string[];
+}
+interface PublicTagsNonNullableFields {
+    tags?: TagListNonNullableFields;
+}
+interface FormSubmissionNonNullableFields {
+    formId: string;
+    namespace: string;
+    status: SubmissionStatus;
+    seen: boolean;
+    orderDetails?: FormSubmissionOrderDetailsNonNullableFields;
+    tags?: PublicTagsNonNullableFields;
+}
+export interface ReportNotSpamSubmissionResponseNonNullableFields {
+    submission?: FormSubmissionNonNullableFields;
+}
+interface BulkReportNotSpamSubmissionResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    formSpamSubmissionReportId: string;
+}
+export interface BulkReportNotSpamSubmissionResponseNonNullableFields {
+    results: BulkReportNotSpamSubmissionResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface ReportSpamSubmissionResponseNonNullableFields {
+    formSpamSubmissionReport?: FormSpamSubmissionReportNonNullableFields;
+}
+interface BulkReportSpamSubmissionResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: FormSpamSubmissionReportNonNullableFields;
+}
+export interface BulkReportSpamSubmissionResponseNonNullableFields {
+    results: BulkReportSpamSubmissionResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface QueryFormSpamSubmissionReportsByNamespaceResponseNonNullableFields {
+    formSpamSubmissionReports: FormSpamSubmissionReportNonNullableFields[];
+}
+interface FormSpamSubmissionReportsCountNonNullableFields {
+    formId: string;
+    totalCount: number;
+}
+export interface CountFormSpamSubmissionReportsResponseNonNullableFields {
+    formsSpamSubmissionReportsCount: FormSpamSubmissionReportsCountNonNullableFields[];
+}
+/**
+ * Checks if submission is a spam.
+ * @param submission - Form submission.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField submission
+ * @requiredField submission.formId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_CHECK_FOR_SPAM
+ * @applicableIdentity VISITOR
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.CheckForSpam
+ */
+export declare function checkForSpam(submission: FormSubmission): Promise<CheckForSpamResponse & CheckForSpamResponseNonNullableFields>;
+/**
+ * Creates a new spam submission.
+ * To upload submission media, use the FormSubmissionService.getMediaUploadUrl endpoint.
+ * @param formSpamSubmissionReport - Form spam submission report to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formSpamSubmissionReport
+ * @requiredField formSpamSubmissionReport.formId
+ * @requiredField formSpamSubmissionReport.reportReason
+ * @requiredField formSpamSubmissionReport.submissions
+ * @requiredField formSpamSubmissionReport.submitter
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_CREATE
+ * @returns The created form spam submission report.
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.CreateFormSpamSubmissionReport
+ */
+export declare function createFormSpamSubmissionReport(formSpamSubmissionReport: FormSpamSubmissionReport): Promise<FormSpamSubmissionReport & FormSpamSubmissionReportNonNullableFields>;
+/**
+ * Get a spam submission by id.
+ * @param formSpamSubmissionReportId - Id of the form spam submission report to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formSpamSubmissionReportId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_READ
+ * @returns The retrieved form spam submission report.
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.GetFormSpamSubmissionReport
+ */
+export declare function getFormSpamSubmissionReport(formSpamSubmissionReportId: string): Promise<FormSpamSubmissionReport & FormSpamSubmissionReportNonNullableFields>;
+/**
+ * Delete a spam submission report.
+ * @param formSpamSubmissionReportId - Id of the form spam submission report to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formSpamSubmissionReportId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_DELETE
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.DeleteFormSpamSubmissionReport
+ */
+export declare function deleteFormSpamSubmissionReport(formSpamSubmissionReportId: string): Promise<void>;
+/**
+ * Deletes report by IDS or all for specific form.
+ * @param formId - Form ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_DELETE
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.BulkDeleteFormSpamSubmissionReport
+ */
+export declare function bulkDeleteFormSpamSubmissionReport(formId: string, options?: BulkDeleteFormSpamSubmissionReportOptions): Promise<BulkDeleteFormSpamSubmissionReportResponse & BulkDeleteFormSpamSubmissionReportResponseNonNullableFields>;
+export interface BulkDeleteFormSpamSubmissionReportOptions {
+    /** Ids of the form spam submission reports to delete. */
+    formSpamSubmissionReportIds?: string[];
+}
+/**
+ * Deletes reports by filter for specific form.
+ * @param filter - Filter object.
+ *
+ * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_DELETE
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.BulkDeleteFormSpamSubmissionReportByFilter
+ */
+export declare function bulkDeleteFormSpamSubmissionReportByFilter(filter: Record<string, any> | null): Promise<BulkDeleteFormSpamSubmissionReportByFilterResponse & BulkDeleteFormSpamSubmissionReportByFilterResponseNonNullableFields>;
+/**
+ * Report a spam submission as not spam. The submission is created, and the spam report is deleted.
+ * Submission automations are triggered the same way as in standard submission creation flow.
+ * @param formSpamSubmissionReportId - Id of the form spam submission report to report as not spam.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formSpamSubmissionReportId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_REPORT_NOT_SPAM
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.ReportNotSpamSubmission
+ */
+export declare function reportNotSpamSubmission(formSpamSubmissionReportId: string): Promise<ReportNotSpamSubmissionResponse & ReportNotSpamSubmissionResponseNonNullableFields>;
+/**
+ * Report a spam submissions as not spam. The submissions is created, and the spam reports is deleted.
+ * Submissions automations are triggered the same way as in standard submission creation flow.
+ * @param formId - Id of the form to which belong reports
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_REPORT_NOT_SPAM
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.BulkReportNotSpamSubmission
+ */
+export declare function bulkReportNotSpamSubmission(formId: string, options?: BulkReportNotSpamSubmissionOptions): Promise<BulkReportNotSpamSubmissionResponse & BulkReportNotSpamSubmissionResponseNonNullableFields>;
+export interface BulkReportNotSpamSubmissionOptions {
+    /** Ids of the form spam submission reports to report as not spam. */
+    formSpamSubmissionReportIds?: string[];
+}
+/**
+ * Report a submission as spam. The spam submission report is created, and the submission is deleted.
+ * @param submissionId - Id of the submission to report as spam.
+ * @param reportReason - Identifies the reason why the submission was reported as spam.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField reportReason
+ * @requiredField submissionId
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_CREATE
+ * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
+ * @permissionId WIX_FORMS.SUBMISSION_DELETE
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Read Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @applicableIdentity APP
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.ReportSpamSubmission
+ */
+export declare function reportSpamSubmission(submissionId: string, reportReason: ReportReason): Promise<ReportSpamSubmissionResponse & ReportSpamSubmissionResponseNonNullableFields>;
+/**
+ * Report multiple submissions as spam. The spam submission reports is created, and the submissions is deleted.
+ * @param formId - Id of the form to which belong submissions to report as spam.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formId
+ * @requiredField options.reportReason
+ * @requiredField options.submissionIds
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_CREATE
+ * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
+ * @permissionId WIX_FORMS.SUBMISSION_DELETE
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Read Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @applicableIdentity APP
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.BulkReportSpamSubmission
+ */
+export declare function bulkReportSpamSubmission(formId: string, options?: BulkReportSpamSubmissionOptions): Promise<BulkReportSpamSubmissionResponse & BulkReportSpamSubmissionResponseNonNullableFields>;
+export interface BulkReportSpamSubmissionOptions {
+    /** Ids of the submissions to report as spam. */
+    submissionIds: string[];
+    /** Identifies the reason why the submission was reported as spam. */
+    reportReason: ReportReason;
+    /** When set, items will be returned on successful report */
+    returnEntity?: boolean;
+}
+/**
+ * Query form spam submission reports using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_FORMS.FORM_SPAM_SUBMISSION_REPORT_READ
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.QueryFormSpamSubmissionReportsByNamespace
+ */
+export declare function queryFormSpamSubmissionReportsByNamespace(): FormSpamSubmissionReportsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface FormSpamSubmissionReportsQueryResult extends QueryCursorResult {
+    items: FormSpamSubmissionReport[];
+    query: FormSpamSubmissionReportsQueryBuilder;
+    next: () => Promise<FormSpamSubmissionReportsQueryResult>;
+    prev: () => Promise<FormSpamSubmissionReportsQueryResult>;
+}
+export interface FormSpamSubmissionReportsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'formId' | 'namespace' | 'reportReason' | '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'formId' | 'reportReason' | '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'formId' | 'reportReason' | '_createdDate' | 'reportedDate', value: any) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | 'formId' | 'reportReason' | '_createdDate' | 'reportedDate'>) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | 'formId' | 'reportReason' | '_createdDate' | 'reportedDate'>) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => FormSpamSubmissionReportsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => FormSpamSubmissionReportsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<FormSpamSubmissionReportsQueryResult>;
+}
+/**
+ * Counts the number of spam submission reports belonging to the specified forms.
+ * @param formIds - Form IDs.
+ * @param namespace - 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formIds
+ * @requiredField namespace
+ * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
+ * @permissionScope Manage Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Read Submissions
+ * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
+ * @applicableIdentity APP
+ * @fqn wix.forms.v4.FormSpamSubmissionReportService.CountFormSpamSubmissionReports
+ */
+export declare function countFormSpamSubmissionReports(formIds: string[], namespace: string): Promise<CountFormSpamSubmissionReportsResponse & CountFormSpamSubmissionReportsResponseNonNullableFields>;
+export {};