@wix/reports 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/reports",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/reports_reports": "1.0.1"
+    "@wix/reports_reports": "1.0.3"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "f5cdaeb6bc8ffcc7ffeab6ab6ae0beb468be564bdcfa704368ae835c"
+  "falconPackageHash": "e3527ead6204e0bd72b9d247f2a4d80aa6e61c1471fe709ac305dc11"
 }

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

@@ -482,7 +482,7 @@ interface Report {
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -491,7 +491,7 @@ interface Report {
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason;
     /**
      * 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.
@@ -499,17 +499,17 @@ interface Report {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -543,23 +543,23 @@ declare enum IdentityType {
 interface Reason {
     /** Report reason type. */
     reasonType?: Type;
-    /** Details of why the entity is reported. */
+    /** 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`. */
+    /** Entity is reported for other reasons. Specify in `details`. */
     OTHER = "OTHER",
     /** Entity is reported for spam. */
     SPAM = "SPAM",
-    /** Entity is reported for nudity. */
+    /** Entity is reported for nudity or sexual harassment. */
     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. */
+    /** Entity is reported for a community guideline violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
     /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
@@ -577,7 +577,7 @@ declare enum Type {
     DRUGS = "DRUGS",
     /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
-    /** Entity is reported for exposing identifying info. */
+    /** Entity is reported for exposing identifying details. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields {
@@ -961,7 +961,7 @@ interface UpdateReport {
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -970,7 +970,7 @@ interface UpdateReport {
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason;
     /**
      * 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.
@@ -978,17 +978,17 @@ interface UpdateReport {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -1006,7 +1006,7 @@ interface UpsertReportOptions {
          * @readonly
          */
         identity?: CommonIdentificationData;
-        /** Reason for report. */
+        /** Reason for the report. */
         reason?: Reason;
         /**
          * 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.
@@ -1014,17 +1014,17 @@ interface UpsertReportOptions {
          */
         revision?: string | null;
         /**
-         * Date and time when the report was created.
+         * Date and time when the report created.
          * @readonly
          */
         _createdDate?: Date | null;
         /**
-         * Date and time when the report was updated.
+         * Date and time when the report updated.
          * @readonly
          */
         _updatedDate?: Date | null;
         /**
-         * Custom field data for the rule object.
+         * Custom field data for the report 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.
          */
@@ -1032,7 +1032,7 @@ interface UpsertReportOptions {
     };
 }
 interface UpsertReportIdentifiers {
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     reportEntityName?: string;
     /** Reported entity ID. */
     reportEntityId?: string;
@@ -1157,7 +1157,7 @@ interface UpdateReportSignature {
 declare function deleteReport$1(httpClient: HttpClient): DeleteReportSignature;
 interface DeleteReportSignature {
     /**
-     * Deletes a report, and removes it from the report list in the dashboard.
+     * Deletes a report and removes it from the report list in the dashboard.
      *
      * Site members and visitors can only delete their own reports.
      * @param - ID of the report to delete.
@@ -1168,7 +1168,7 @@ declare function upsertReport$1(httpClient: HttpClient): UpsertReportSignature;
 interface UpsertReportSignature {
     /**
      * Creates or updates a report.
-     * If the report for the requested entity already exists, then the report is updated with the provided `reason` value. Otherwise, the report is created.
+     * If the report for the requested entity already exists, updates the report with the provided `reason` value. Otherwise, creates the report.
      */
     (identifiers: UpsertReportIdentifiers, options?: UpsertReportOptions | undefined): Promise<UpsertReportResponse & UpsertReportResponseNonNullableFields>;
 }
@@ -1183,7 +1183,7 @@ interface BulkDeleteReportsByFilterSignature {
 declare function countReportsByReasonTypes$1(httpClient: HttpClient): CountReportsByReasonTypesSignature;
 interface CountReportsByReasonTypesSignature {
     /**
-     * Counts reports by reasons.
+     * Counts reports by reason types.
      * @param - Reported entity name. For example, `comment`.
      */
     (entityName: string, options: CountReportsByReasonTypesOptions): Promise<CountReportsByReasonTypesResponse & CountReportsByReasonTypesResponseNonNullableFields>;
@@ -1196,6 +1196,7 @@ interface QueryReportsSignature {
      * - `createdDate` is sorted in `ASC` order
      * - `paging.limit` is `100`
      * - `paging.offset` is `0`
+     *
      * For field support for filters and sorting, see [Reports: Supported Filters and Sorting]().
      * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
      */
@@ -1241,7 +1242,9 @@ type _publicOnReportDeletedType = typeof onReportDeleted$1;
 declare const onReportDeleted: ReturnType<typeof createEventModule<_publicOnReportDeletedType>>;
 
 type _publicOnReportEntityReportSummaryChangedType = typeof onReportEntityReportSummaryChanged$1;
-/** */
+/**
+ * Triggered when count of reports by reason is updated.
+ */
 declare const onReportEntityReportSummaryChanged: ReturnType<typeof createEventModule<_publicOnReportEntityReportSummaryChangedType>>;
 
 type _publicOnReportUpdatedType = typeof onReportUpdated$1;

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

@@ -482,7 +482,7 @@ interface Report {
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -491,7 +491,7 @@ interface Report {
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason;
     /**
      * 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.
@@ -499,17 +499,17 @@ interface Report {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -543,23 +543,23 @@ declare enum IdentityType {
 interface Reason {
     /** Report reason type. */
     reasonType?: Type;
-    /** Details of why the entity is reported. */
+    /** 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`. */
+    /** Entity is reported for other reasons. Specify in `details`. */
     OTHER = "OTHER",
     /** Entity is reported for spam. */
     SPAM = "SPAM",
-    /** Entity is reported for nudity. */
+    /** Entity is reported for nudity or sexual harassment. */
     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. */
+    /** Entity is reported for a community guideline violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
     /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
@@ -577,7 +577,7 @@ declare enum Type {
     DRUGS = "DRUGS",
     /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
-    /** Entity is reported for exposing identifying info. */
+    /** Entity is reported for exposing identifying details. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields {
@@ -961,7 +961,7 @@ interface UpdateReport {
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -970,7 +970,7 @@ interface UpdateReport {
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason;
     /**
      * 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.
@@ -978,17 +978,17 @@ interface UpdateReport {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -1006,7 +1006,7 @@ interface UpsertReportOptions {
          * @readonly
          */
         identity?: CommonIdentificationData;
-        /** Reason for report. */
+        /** Reason for the report. */
         reason?: Reason;
         /**
          * 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.
@@ -1014,17 +1014,17 @@ interface UpsertReportOptions {
          */
         revision?: string | null;
         /**
-         * Date and time when the report was created.
+         * Date and time when the report created.
          * @readonly
          */
         _createdDate?: Date | null;
         /**
-         * Date and time when the report was updated.
+         * Date and time when the report updated.
          * @readonly
          */
         _updatedDate?: Date | null;
         /**
-         * Custom field data for the rule object.
+         * Custom field data for the report 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.
          */
@@ -1032,7 +1032,7 @@ interface UpsertReportOptions {
     };
 }
 interface UpsertReportIdentifiers {
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     reportEntityName?: string;
     /** Reported entity ID. */
     reportEntityId?: string;
@@ -1157,7 +1157,7 @@ interface UpdateReportSignature {
 declare function deleteReport$1(httpClient: HttpClient): DeleteReportSignature;
 interface DeleteReportSignature {
     /**
-     * Deletes a report, and removes it from the report list in the dashboard.
+     * Deletes a report and removes it from the report list in the dashboard.
      *
      * Site members and visitors can only delete their own reports.
      * @param - ID of the report to delete.
@@ -1168,7 +1168,7 @@ declare function upsertReport$1(httpClient: HttpClient): UpsertReportSignature;
 interface UpsertReportSignature {
     /**
      * Creates or updates a report.
-     * If the report for the requested entity already exists, then the report is updated with the provided `reason` value. Otherwise, the report is created.
+     * If the report for the requested entity already exists, updates the report with the provided `reason` value. Otherwise, creates the report.
      */
     (identifiers: UpsertReportIdentifiers, options?: UpsertReportOptions | undefined): Promise<UpsertReportResponse & UpsertReportResponseNonNullableFields>;
 }
@@ -1183,7 +1183,7 @@ interface BulkDeleteReportsByFilterSignature {
 declare function countReportsByReasonTypes$1(httpClient: HttpClient): CountReportsByReasonTypesSignature;
 interface CountReportsByReasonTypesSignature {
     /**
-     * Counts reports by reasons.
+     * Counts reports by reason types.
      * @param - Reported entity name. For example, `comment`.
      */
     (entityName: string, options: CountReportsByReasonTypesOptions): Promise<CountReportsByReasonTypesResponse & CountReportsByReasonTypesResponseNonNullableFields>;
@@ -1196,6 +1196,7 @@ interface QueryReportsSignature {
      * - `createdDate` is sorted in `ASC` order
      * - `paging.limit` is `100`
      * - `paging.offset` is `0`
+     *
      * For field support for filters and sorting, see [Reports: Supported Filters and Sorting]().
      * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
      */
@@ -1241,7 +1242,9 @@ type _publicOnReportDeletedType = typeof onReportDeleted$1;
 declare const onReportDeleted: ReturnType<typeof createEventModule<_publicOnReportDeletedType>>;
 
 type _publicOnReportEntityReportSummaryChangedType = typeof onReportEntityReportSummaryChanged$1;
-/** */
+/**
+ * Triggered when count of reports by reason is updated.
+ */
 declare const onReportEntityReportSummaryChanged: ReturnType<typeof createEventModule<_publicOnReportEntityReportSummaryChangedType>>;
 
 type _publicOnReportUpdatedType = typeof onReportUpdated$1;

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

@@ -4,7 +4,7 @@ interface Report$1 {
      * @readonly
      */
     id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -13,7 +13,7 @@ interface Report$1 {
      * @readonly
      */
     identity?: CommonIdentificationData$1;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason$1;
     /**
      * 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.
@@ -21,17 +21,17 @@ interface Report$1 {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -65,23 +65,23 @@ declare enum IdentityType$1 {
 interface Reason$1 {
     /** Report reason type. */
     reasonType?: Type$1;
-    /** Details of why the entity is reported. */
+    /** 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`. */
+    /** Entity is reported for other reasons. Specify in `details`. */
     OTHER = "OTHER",
     /** Entity is reported for spam. */
     SPAM = "SPAM",
-    /** Entity is reported for nudity. */
+    /** Entity is reported for nudity or sexual harassment. */
     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. */
+    /** Entity is reported for a community guideline violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
     /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
@@ -99,7 +99,7 @@ declare enum Type$1 {
     DRUGS = "DRUGS",
     /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
-    /** Entity is reported for exposing identifying info. */
+    /** Entity is reported for exposing identifying details. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields$1 {
@@ -294,7 +294,7 @@ interface Report {
      * @readonly
      */
     _id?: string | null;
-    /** Reported entity name. For example, `comment`. */
+    /** Reported entity name, such as `comment`. */
     entityName?: string;
     /** Reported entity ID. */
     entityId?: string;
@@ -303,7 +303,7 @@ interface Report {
      * @readonly
      */
     identity?: CommonIdentificationData;
-    /** Reason for report. */
+    /** Reason for the report. */
     reason?: Reason;
     /**
      * 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.
@@ -311,17 +311,17 @@ interface Report {
      */
     revision?: string | null;
     /**
-     * Date and time when the report was created.
+     * Date and time when the report created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time when the report was updated.
+     * Date and time when the report updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Custom field data for the rule object.
+     * Custom field data for the report 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.
      */
@@ -355,23 +355,23 @@ declare enum IdentityType {
 interface Reason {
     /** Report reason type. */
     reasonType?: Type;
-    /** Details of why the entity is reported. */
+    /** 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`. */
+    /** Entity is reported for other reasons. Specify in `details`. */
     OTHER = "OTHER",
     /** Entity is reported for spam. */
     SPAM = "SPAM",
-    /** Entity is reported for nudity. */
+    /** Entity is reported for nudity or sexual harassment. */
     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. */
+    /** Entity is reported for a community guideline violation. */
     COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
     /** Entity is reported for violence. */
     VIOLENCE = "VIOLENCE",
@@ -389,7 +389,7 @@ declare enum Type {
     DRUGS = "DRUGS",
     /** Entity is reported for unlawful actions. */
     UNLAWFUL = "UNLAWFUL",
-    /** Entity is reported for exposing identifying info. */
+    /** Entity is reported for exposing identifying details. */
     EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
 }
 interface ExtendedFields {