@wix/reports 1.0.0 → 1.0.2

package/type-bundles/meta.bundle.d.ts

@@ -1,40 +1,40 @@
-/**
- * A Report is an entity defining a UoU complaint with a reason on the site
- * You can report an entity from a select number of reasons, also providing details for the report
- */
 interface Report$1 {
     /**
      * Report ID.
      * @readonly
      */
     id?: string | null;
-    /** Reported entity name */
+    /** Reported entity name. For example, `comment`. */
     entityName?: string;
-    /** Reported entity ID */
+    /** Reported entity ID. */
     entityId?: string;
     /**
-     * Identity of who made a report
+     * Identity of who created a report.
      * @readonly
      */
     identity?: CommonIdentificationData$1;
-    /** Reason for the report */
+    /** Reason for report. */
     reason?: Reason$1;
     /**
-     * Revision number, which increments by 1 each time the Report is updated.
+     * Revision number, which increments by 1 each time the rule is updated. To prevent conflicting changes, the existing revision must be used when updating a rule.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the Report was created.
+     * Date and time when the report was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Date and time the Report was last updated.
+     * Date and time when the report was updated.
      * @readonly
      */
     updatedDate?: Date | null;
-    /** Data Extensions */
+    /**
+     * Custom field data for the rule object.
+     *
+     * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
+     */
     extendedFields?: ExtendedFields$1;
 }
 interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
@@ -63,27 +63,43 @@ declare enum IdentityType$1 {
     APP = "APP"
 }
 interface Reason$1 {
-    /** Type of reason selected for the report */
+    /** Report reason type. */
     reasonType?: Type$1;
-    /** Optional details provided alongside the report */
+    /** Details of why the entity is reported. */
     details?: string | null;
 }
 declare enum Type$1 {
+    /** Unknown type. This value is not used. */
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Entity is reported for other reasons, specify in `details`. */
     OTHER = "OTHER",
+    /** Entity is reported for spam. */
     SPAM = "SPAM",
+    /** Entity is reported for nudity. */
     NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
+    /** Entity is reported for hate speech. */
     HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
+    /** Entity is reported for false information. */
     FALSE_INFORMATION = "FALSE_INFORMATION",
+    /** Entity is reported for community guidelines violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
+    /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
+    /** Entity is reported for mentioning suicide. */
     SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
+    /** Entity is reported for unuathorized sales. */
     UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
+    /** Entity is reported for mentioning an eating disorder. */
     EATING_DISORDER = "EATING_DISORDER",
+    /** Entity is reported for involving a minor. */
     INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
+    /** Entity is reported for mentioning terrorism. */
     TERRORISM = "TERRORISM",
+    /** Entity is reported for mentioning drugs. */
     DRUGS = "DRUGS",
+    /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
+    /** Entity is reported for exposing identifying info. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields$1 {
@@ -98,69 +114,69 @@ interface ExtendedFields$1 {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface CreateReportRequest$1 {
-    /** Report to be created. */
+    /** Report details. */
     report: Report$1;
 }
 interface CreateReportResponse$1 {
-    /** The created Report. */
+    /** Created report. */
     report?: Report$1;
 }
 interface GetReportRequest$1 {
-    /** ID of the Report to retrieve. */
+    /** ID of the report to retrieve. */
     reportId: string;
 }
 interface GetReportResponse$1 {
-    /** The requested Report. */
+    /** Retrieved report. */
     report?: Report$1;
 }
 interface UpdateReportRequest$1 {
-    /** Report to be updated, may be partial. */
+    /** Report to update. */
     report: Report$1;
 }
 interface UpdateReportResponse$1 {
-    /** Updated Report. */
+    /** Updated report. */
     report?: Report$1;
 }
 interface DeleteReportRequest$1 {
-    /** Id of the Report to delete. */
+    /** ID of the report to delete. */
     reportId: string;
 }
 interface DeleteReportResponse$1 {
 }
 interface UpsertReportRequest$1 {
-    /** Report to be upserted. */
+    /** Report to create or update. */
     report?: Report$1;
 }
 interface UpsertReportResponse$1 {
-    /** Updated or created Report. */
+    /** Updated or created report. */
     report?: Report$1;
 }
 interface BulkDeleteReportsByFilterRequest$1 {
-    /** Filter for which reports to delete */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     filter: Record<string, any> | null;
 }
 interface BulkDeleteReportsByFilterResponse$1 {
-    /** Reference to async job ID */
+    /** Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */
     jobId?: string;
 }
 interface CountReportsByReasonTypesRequest$1 {
-    /** Entity name */
+    /** Reported entity name. For example, `comment`. */
     entityName: string;
-    /** ID of the entity. */
+    /** ID of the reported entity. */
     entityId: string;
 }
 interface CountReportsByReasonTypesResponse$1 {
-    /** The list of entity reports grouped by report reason. */
+    /** List of reports grouped by the reason type. */
     reasonTypeCount?: ReasonTypeCount$1[];
 }
 interface ReasonTypeCount$1 {
-    /** Type of reason selected for the report */
+    /** Reason for report. */
     reasonType?: Type$1;
-    /** Report count */
+    /** Number of reports by reason type. */
     count?: number;
 }
 interface QueryReportsRequest$1 {
-    /** WQL expression. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     query?: CursorQuery$1;
 }
 interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
@@ -196,9 +212,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryReportsResponse$1 {
-    /** List of Reports. */
+    /** List of reports. */
     reports?: Report$1[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
@@ -216,7 +232,7 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface UpdateExtendedFieldsRequest$1 {
-    /** ID of the entity to update. */
+    /** ID of the report to update. */
     id: string;
     /** Identifier for the app whose extended fields are being updated. */
     namespace: string;
@@ -224,7 +240,7 @@ interface UpdateExtendedFieldsRequest$1 {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse$1 {
-    /** Updated Report. */
+    /** Updated report. */
     report?: Report$1;
 }
 interface CommonIdentificationDataNonNullableFields$1 {
@@ -272,43 +288,43 @@ interface UpdateExtendedFieldsResponseNonNullableFields$1 {
     report?: ReportNonNullableFields$1;
 }
 
-/**
- * A Report is an entity defining a UoU complaint with a reason on the site
- * You can report an entity from a select number of reasons, also providing details for the report
- */
 interface Report {
     /**
      * Report ID.
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name */
+    /** Reported entity name. For example, `comment`. */
     entityName?: string;
-    /** Reported entity ID */
+    /** Reported entity ID. */
     entityId?: string;
     /**
-     * Identity of who made a report
+     * Identity of who created a report.
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for the report */
+    /** Reason for report. */
     reason?: Reason;
     /**
-     * Revision number, which increments by 1 each time the Report is updated.
+     * Revision number, which increments by 1 each time the rule is updated. To prevent conflicting changes, the existing revision must be used when updating a rule.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the Report was created.
+     * Date and time when the report was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the Report was last updated.
+     * Date and time when the report was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Data Extensions */
+    /**
+     * Custom field data for the rule object.
+     *
+     * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
+     */
     extendedFields?: ExtendedFields;
 }
 interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
@@ -337,27 +353,43 @@ declare enum IdentityType {
     APP = "APP"
 }
 interface Reason {
-    /** Type of reason selected for the report */
+    /** Report reason type. */
     reasonType?: Type;
-    /** Optional details provided alongside the report */
+    /** Details of why the entity is reported. */
     details?: string | null;
 }
 declare enum Type {
+    /** Unknown type. This value is not used. */
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Entity is reported for other reasons, specify in `details`. */
     OTHER = "OTHER",
+    /** Entity is reported for spam. */
     SPAM = "SPAM",
+    /** Entity is reported for nudity. */
     NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
+    /** Entity is reported for hate speech. */
     HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
+    /** Entity is reported for false information. */
     FALSE_INFORMATION = "FALSE_INFORMATION",
+    /** Entity is reported for community guidelines violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
+    /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
+    /** Entity is reported for mentioning suicide. */
     SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
+    /** Entity is reported for unuathorized sales. */
     UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
+    /** Entity is reported for mentioning an eating disorder. */
     EATING_DISORDER = "EATING_DISORDER",
+    /** Entity is reported for involving a minor. */
     INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
+    /** Entity is reported for mentioning terrorism. */
     TERRORISM = "TERRORISM",
+    /** Entity is reported for mentioning drugs. */
     DRUGS = "DRUGS",
+    /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
+    /** Entity is reported for exposing identifying info. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields {
@@ -372,69 +404,69 @@ interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface CreateReportRequest {
-    /** Report to be created. */
+    /** Report details. */
     report: Report;
 }
 interface CreateReportResponse {
-    /** The created Report. */
+    /** Created report. */
     report?: Report;
 }
 interface GetReportRequest {
-    /** ID of the Report to retrieve. */
+    /** ID of the report to retrieve. */
     reportId: string;
 }
 interface GetReportResponse {
-    /** The requested Report. */
+    /** Retrieved report. */
     report?: Report;
 }
 interface UpdateReportRequest {
-    /** Report to be updated, may be partial. */
+    /** Report to update. */
     report: Report;
 }
 interface UpdateReportResponse {
-    /** Updated Report. */
+    /** Updated report. */
     report?: Report;
 }
 interface DeleteReportRequest {
-    /** Id of the Report to delete. */
+    /** ID of the report to delete. */
     reportId: string;
 }
 interface DeleteReportResponse {
 }
 interface UpsertReportRequest {
-    /** Report to be upserted. */
+    /** Report to create or update. */
     report?: Report;
 }
 interface UpsertReportResponse {
-    /** Updated or created Report. */
+    /** Updated or created report. */
     report?: Report;
 }
 interface BulkDeleteReportsByFilterRequest {
-    /** Filter for which reports to delete */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     filter: Record<string, any> | null;
 }
 interface BulkDeleteReportsByFilterResponse {
-    /** Reference to async job ID */
+    /** Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */
     jobId?: string;
 }
 interface CountReportsByReasonTypesRequest {
-    /** Entity name */
+    /** Reported entity name. For example, `comment`. */
     entityName: string;
-    /** ID of the entity. */
+    /** ID of the reported entity. */
     entityId: string;
 }
 interface CountReportsByReasonTypesResponse {
-    /** The list of entity reports grouped by report reason. */
+    /** List of reports grouped by the reason type. */
     reasonTypeCount?: ReasonTypeCount[];
 }
 interface ReasonTypeCount {
-    /** Type of reason selected for the report */
+    /** Reason for report. */
     reasonType?: Type;
-    /** Report count */
+    /** Number of reports by reason type. */
     count?: number;
 }
 interface QueryReportsRequest {
-    /** WQL expression. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -470,9 +502,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryReportsResponse {
-    /** List of Reports. */
+    /** List of reports. */
     reports?: Report[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -490,7 +522,7 @@ interface Cursors {
     prev?: string | null;
 }
 interface UpdateExtendedFieldsRequest {
-    /** ID of the entity to update. */
+    /** ID of the report to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
     namespace: string;
@@ -498,7 +530,7 @@ interface UpdateExtendedFieldsRequest {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse {
-    /** Updated Report. */
+    /** Updated report. */
     report?: Report;
 }
 interface CommonIdentificationDataNonNullableFields {