@wix/auto_sdk_forms_form-spam-submission-reports 1.0.4 → 1.0.6

package/build/cjs/index.d.ts

@@ -1 +1,125 @@
-export * from './src/forms-v4-form-spam-submission-report-form-spam-submission-reports.context.js';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { FormSubmission, CheckForSpamResponse, FormSpamSubmissionReport, CreateFormSpamSubmissionReportValidationErrors, BulkDeleteFormSpamSubmissionReportOptions, BulkDeleteFormSpamSubmissionReportResponse, BulkDeleteFormSpamSubmissionReportByFilterResponse, ReportNotSpamSubmissionResponse, BulkReportNotSpamSubmissionOptions, BulkReportNotSpamSubmissionResponse, ReportReasonWithLiterals, ReportSpamSubmissionOptions, ReportSpamSubmissionResponse, BulkReportSpamSubmissionOptions, BulkReportSpamSubmissionResponse, FormSpamSubmissionReportsQueryBuilder, CountFormSpamSubmissionReportsResponse } from './index.typings.js';
+export { ActionEvent, ApplicationError, BulkActionMetadata, BulkDeleteFormSpamSubmissionReportByFilterRequest, BulkDeleteFormSpamSubmissionReportRequest, BulkDeleteFormSpamSubmissionReportResult, BulkReportNotSpamSubmissionRequest, BulkReportNotSpamSubmissionResult, BulkReportSpamSubmissionRequest, BulkReportSpamSubmissionResult, CheckForSpamRequest, CountFormSpamSubmissionReportsRequest, CreateFormSpamSubmissionReportRequest, CreateFormSpamSubmissionReportResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteFormSpamSubmissionReportRequest, DeleteFormSpamSubmissionReportResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ErrorType, ExtendedFields, FormSpamSubmissionReportValidationErrorsDetails, FormSpamSubmissionReportsCount, FormSpamSubmissionReportsQueryResult, FormSubmissionOrderDetails, GetFormSpamSubmissionReportRequest, GetFormSpamSubmissionReportResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, OrderDetails, PublicTags, QueryFormSpamSubmissionReportsByNamespaceRequest, QueryFormSpamSubmissionReportsByNamespaceResponse, ReportNotSpamSubmissionRequest, ReportReason, ReportSpamSubmissionRequest, RestoreInfo, SortOrder, Sorting, SpamReport, SubmissionStatus, Submitter, SubmitterSubmitterOneOf, TagList, ValidationError, WebhookIdentityType } from './index.typings.js';
+
+declare function checkForSpam$1(httpClient: HttpClient): CheckForSpamSignature;
+interface CheckForSpamSignature {
+    /**
+     * Checks if submission is a spam.
+     * @param - Form submission.
+     */
+    (submission: NonNullablePaths<FormSubmission, `formId`>): Promise<NonNullablePaths<CheckForSpamResponse, `spam` | `spamReport.reportReason`>>;
+}
+declare function createFormSpamSubmissionReport$1(httpClient: HttpClient): CreateFormSpamSubmissionReportSignature;
+interface CreateFormSpamSubmissionReportSignature {
+    /**
+     * Creates a new spam submission.
+     * To upload submission media, use the FormSubmissionService.getMediaUploadUrl endpoint.
+     * @param - Form spam submission report to be created.
+     * @returns The created form spam submission report.
+     */
+    (formSpamSubmissionReport: NonNullablePaths<FormSpamSubmissionReport, `formId` | `reportReason` | `submissions` | `submitter`>): Promise<NonNullablePaths<FormSpamSubmissionReport, `formId` | `namespace` | `reportReason` | `submissionStatusAtReport` | `orderDetails.checkoutId`> & {
+        __validationErrorsType?: CreateFormSpamSubmissionReportValidationErrors;
+    }>;
+}
+declare function getFormSpamSubmissionReport$1(httpClient: HttpClient): GetFormSpamSubmissionReportSignature;
+interface GetFormSpamSubmissionReportSignature {
+    /**
+     * Get a spam submission by id.
+     * @param - Id of the form spam submission report to retrieve.
+     * @returns The retrieved form spam submission report.
+     */
+    (formSpamSubmissionReportId: string): Promise<NonNullablePaths<FormSpamSubmissionReport, `formId` | `namespace` | `reportReason` | `submissionStatusAtReport` | `orderDetails.checkoutId`>>;
+}
+declare function deleteFormSpamSubmissionReport$1(httpClient: HttpClient): DeleteFormSpamSubmissionReportSignature;
+interface DeleteFormSpamSubmissionReportSignature {
+    /**
+     * Delete a spam submission report.
+     * @param - Id of the form spam submission report to delete.
+     */
+    (formSpamSubmissionReportId: string): Promise<void>;
+}
+declare function bulkDeleteFormSpamSubmissionReport$1(httpClient: HttpClient): BulkDeleteFormSpamSubmissionReportSignature;
+interface BulkDeleteFormSpamSubmissionReportSignature {
+    /**
+     * Deletes report by IDS or all for specific form.
+     * @param - Form ID.
+     */
+    (formId: string, options?: BulkDeleteFormSpamSubmissionReportOptions): Promise<NonNullablePaths<BulkDeleteFormSpamSubmissionReportResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+}
+declare function bulkDeleteFormSpamSubmissionReportByFilter$1(httpClient: HttpClient): BulkDeleteFormSpamSubmissionReportByFilterSignature;
+interface BulkDeleteFormSpamSubmissionReportByFilterSignature {
+    /**
+     * Deletes reports by filter for specific form.
+     * @param - Filter object.
+     *
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+     */
+    (filter: Record<string, any>): Promise<NonNullablePaths<BulkDeleteFormSpamSubmissionReportByFilterResponse, `jobId`>>;
+}
+declare function reportNotSpamSubmission$1(httpClient: HttpClient): ReportNotSpamSubmissionSignature;
+interface ReportNotSpamSubmissionSignature {
+    /**
+     * 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 - Id of the form spam submission report to report as not spam.
+     */
+    (formSpamSubmissionReportId: string): Promise<NonNullablePaths<ReportNotSpamSubmissionResponse, `submission.formId` | `submission.namespace` | `submission.status` | `submission.seen` | `submission.orderDetails.itemSubtotal` | `submission.orderDetails.checkoutId` | `submission.tags.tags.tagIds`>>;
+}
+declare function bulkReportNotSpamSubmission$1(httpClient: HttpClient): BulkReportNotSpamSubmissionSignature;
+interface BulkReportNotSpamSubmissionSignature {
+    /**
+     * 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 - Id of the form to which belong reports
+     */
+    (formId: string, options?: BulkReportNotSpamSubmissionOptions): Promise<NonNullablePaths<BulkReportNotSpamSubmissionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.formSpamSubmissionReportId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+}
+declare function reportSpamSubmission$1(httpClient: HttpClient): ReportSpamSubmissionSignature;
+interface ReportSpamSubmissionSignature {
+    /**
+     * Report a submission as spam. The spam submission report is created, and the submission is deleted.
+     * @param - Id of the submission to report as spam.
+     * @param - Identifies the reason why the submission was reported as spam.
+     */
+    (submissionId: string, reportReason: ReportReasonWithLiterals, options?: ReportSpamSubmissionOptions): Promise<NonNullablePaths<ReportSpamSubmissionResponse, `formSpamSubmissionReport.formId` | `formSpamSubmissionReport.namespace` | `formSpamSubmissionReport.reportReason` | `formSpamSubmissionReport.submissionStatusAtReport` | `formSpamSubmissionReport.orderDetails.checkoutId`>>;
+}
+declare function bulkReportSpamSubmission$1(httpClient: HttpClient): BulkReportSpamSubmissionSignature;
+interface BulkReportSpamSubmissionSignature {
+    /**
+     * Report multiple submissions as spam. The spam submission reports is created, and the submissions is deleted.
+     * @param - Id of the form to which belong submissions to report as spam.
+     */
+    (formId: string, options?: NonNullablePaths<BulkReportSpamSubmissionOptions, `reportReason` | `submissionIds`>): Promise<NonNullablePaths<BulkReportSpamSubmissionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.formId` | `results.${number}.item.namespace` | `results.${number}.item.reportReason` | `results.${number}.item.submissionStatusAtReport` | `results.${number}.item.orderDetails.checkoutId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+}
+declare function queryFormSpamSubmissionReportsByNamespace$1(httpClient: HttpClient): QueryFormSpamSubmissionReportsByNamespaceSignature;
+interface QueryFormSpamSubmissionReportsByNamespaceSignature {
+    /**
+     * Query form spam submission reports using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     */
+    (): FormSpamSubmissionReportsQueryBuilder;
+}
+declare function countFormSpamSubmissionReports$1(httpClient: HttpClient): CountFormSpamSubmissionReportsSignature;
+interface CountFormSpamSubmissionReportsSignature {
+    /**
+     * Counts the number of spam submission reports belonging to the specified forms.
+     * @param - Form IDs.
+     * @param - 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.
+     */
+    (formIds: string[], namespace: string): Promise<NonNullablePaths<CountFormSpamSubmissionReportsResponse, `formsSpamSubmissionReportsCount` | `formsSpamSubmissionReportsCount.${number}.formId` | `formsSpamSubmissionReportsCount.${number}.totalCount`>>;
+}
+
+declare const checkForSpam: MaybeContext<BuildRESTFunction<typeof checkForSpam$1> & typeof checkForSpam$1>;
+declare const createFormSpamSubmissionReport: MaybeContext<BuildRESTFunction<typeof createFormSpamSubmissionReport$1> & typeof createFormSpamSubmissionReport$1>;
+declare const getFormSpamSubmissionReport: MaybeContext<BuildRESTFunction<typeof getFormSpamSubmissionReport$1> & typeof getFormSpamSubmissionReport$1>;
+declare const deleteFormSpamSubmissionReport: MaybeContext<BuildRESTFunction<typeof deleteFormSpamSubmissionReport$1> & typeof deleteFormSpamSubmissionReport$1>;
+declare const bulkDeleteFormSpamSubmissionReport: MaybeContext<BuildRESTFunction<typeof bulkDeleteFormSpamSubmissionReport$1> & typeof bulkDeleteFormSpamSubmissionReport$1>;
+declare const bulkDeleteFormSpamSubmissionReportByFilter: MaybeContext<BuildRESTFunction<typeof bulkDeleteFormSpamSubmissionReportByFilter$1> & typeof bulkDeleteFormSpamSubmissionReportByFilter$1>;
+declare const reportNotSpamSubmission: MaybeContext<BuildRESTFunction<typeof reportNotSpamSubmission$1> & typeof reportNotSpamSubmission$1>;
+declare const bulkReportNotSpamSubmission: MaybeContext<BuildRESTFunction<typeof bulkReportNotSpamSubmission$1> & typeof bulkReportNotSpamSubmission$1>;
+declare const reportSpamSubmission: MaybeContext<BuildRESTFunction<typeof reportSpamSubmission$1> & typeof reportSpamSubmission$1>;
+declare const bulkReportSpamSubmission: MaybeContext<BuildRESTFunction<typeof bulkReportSpamSubmission$1> & typeof bulkReportSpamSubmission$1>;
+declare const queryFormSpamSubmissionReportsByNamespace: MaybeContext<BuildRESTFunction<typeof queryFormSpamSubmissionReportsByNamespace$1> & typeof queryFormSpamSubmissionReportsByNamespace$1>;
+declare const countFormSpamSubmissionReports: MaybeContext<BuildRESTFunction<typeof countFormSpamSubmissionReports$1> & typeof countFormSpamSubmissionReports$1>;
+
+export { BulkDeleteFormSpamSubmissionReportByFilterResponse, BulkDeleteFormSpamSubmissionReportOptions, BulkDeleteFormSpamSubmissionReportResponse, BulkReportNotSpamSubmissionOptions, BulkReportNotSpamSubmissionResponse, BulkReportSpamSubmissionOptions, BulkReportSpamSubmissionResponse, CheckForSpamResponse, CountFormSpamSubmissionReportsResponse, FormSpamSubmissionReport, FormSpamSubmissionReportsQueryBuilder, FormSubmission, ReportNotSpamSubmissionResponse, ReportSpamSubmissionOptions, ReportSpamSubmissionResponse, bulkDeleteFormSpamSubmissionReport, bulkDeleteFormSpamSubmissionReportByFilter, bulkReportNotSpamSubmission, bulkReportSpamSubmission, checkForSpam, countFormSpamSubmissionReports, createFormSpamSubmissionReport, deleteFormSpamSubmissionReport, getFormSpamSubmissionReport, queryFormSpamSubmissionReportsByNamespace, reportNotSpamSubmission, reportSpamSubmission };