@wix/auto_sdk_members_member-report 1.0.10 → 1.0.11

package/build/{internal/members-v1-member-report-member-report.universal-BBR1zWhW.d.ts → es/src/members-v1-member-report-member-report.universal.d.ts}

@@ -1,4 +1,5 @@
-interface MemberReport {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface MemberReport {
     /**
      * Report ID.
      * @format GUID
@@ -23,13 +24,13 @@ interface MemberReport {
      */
     _createdDate?: Date | null;
 }
-interface Reason {
+export interface Reason {
     /** Report reason type. */
     category?: Category;
     /** Explanation of why the member is being reported. */
     description?: string | null;
 }
-declare enum Category {
+export declare enum Category {
     /** Unknown category. This value is unused. */
     UNKNOWN = "UNKNOWN",
     /** The member is reported for spam. */
@@ -41,19 +42,19 @@ declare enum Category {
     /** The member is reported for other reasons. */
     OTHER = "OTHER"
 }
-interface ReportMemberRequest {
+export interface ReportMemberRequest {
     /** Details of a member to report. */
     memberReport: MemberReport;
 }
-interface ReportMemberResponse {
+export interface ReportMemberResponse {
     /** Member report. */
     memberReport?: MemberReport;
 }
-interface ReportedMemberCreated {
+export interface ReportedMemberCreated {
     reportedMember?: ReportedMember;
 }
 /** Reported member details. */
-interface ReportedMember {
+export interface ReportedMember {
     /**
      * ID of the reported member.
      * @format GUID
@@ -69,25 +70,25 @@ interface ReportedMember {
      */
     lastReportDate?: Date | null;
 }
-interface SelfReportingForbiddenError {
+export interface SelfReportingForbiddenError {
     /**
      * ID of the member that is reported.
      * @format GUID
      */
     memberId?: string;
 }
-interface CannotReportBlockedMemberError {
+export interface CannotReportBlockedMemberError {
     /**
      * ID of the member that is reported.
      * @format GUID
      */
     memberId?: string;
 }
-interface QueryMemberReportsRequest {
+export interface QueryMemberReportsRequest {
     /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     query?: QueryV2;
 }
-interface QueryV2 {
+export interface QueryV2 {
     /**
      * Filter object in the following format:
      * `"filter" : {
@@ -107,7 +108,7 @@ interface QueryV2 {
     /** Paging options to limit and skip the number of items. */
     paging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -116,11 +117,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * The number of items to load.
      * Default: `100`
@@ -130,13 +131,13 @@ interface CursorPaging {
     /** 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`. */
     cursor?: string | null;
 }
-interface QueryMemberReportsResponse {
+export interface QueryMemberReportsResponse {
     /** Retrieved member reports. */
     memberReports?: MemberReport[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-interface PagingMetadataV2 {
+export interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -148,7 +149,7 @@ interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -160,27 +161,27 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface MarkMemberReportsAsReviewedRequest {
+export interface MarkMemberReportsAsReviewedRequest {
     /**
      * ID of the member whose reports are to be marked as reviewed.
      * @format GUID
      */
     memberId?: string;
 }
-interface MarkMemberReportsAsReviewedResponse {
+export interface MarkMemberReportsAsReviewedResponse {
     /** Reported member details. */
     reportedMember?: ReportedMember;
 }
-interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
+export interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
     /** 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;
 }
 /** @oneof */
-interface ListReportedMembersRequestPagingMethodOneOf {
+export interface ListReportedMembersRequestPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Paging {
+export interface Paging {
     /**
      * Number of items to load.
      * @max 100
@@ -189,36 +190,36 @@ interface Paging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-interface ListReportedMembersResponse {
+export interface ListReportedMembersResponse {
     /** Retrieved reported members. */
     reportedMembers?: ReportedMember[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-interface QueryReportedMembersRequest {
+export interface QueryReportedMembersRequest {
     /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     query?: QueryV2;
 }
-interface QueryReportedMembersResponse {
+export interface QueryReportedMembersResponse {
     /** Retrieved reported members. */
     reportedMembers?: ReportedMember[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-interface DeleteMemberReportsRequest {
+export interface DeleteMemberReportsRequest {
     /**
      * ID of the member whose reports are to be deleted.
      * @format GUID
      */
     memberId: string;
 }
-interface DeleteMemberReportsResponse {
+export interface DeleteMemberReportsResponse {
 }
-interface ReportedMemberDeleted {
+export interface ReportedMemberDeleted {
     /** @format GUID */
     reportedMemberId?: string;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -261,19 +262,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -281,16 +282,16 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface Empty {
+export interface Empty {
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -306,7 +307,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -331,7 +332,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -353,14 +354,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -374,7 +375,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -412,21 +413,104 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface MemberReportCreatedEnvelope {
+export interface MemberReportCreatedEnvelope {
     entity: MemberReport;
     metadata: EventMetadata;
 }
-interface MemberReportDeletedEnvelope {
+/**
+ * Triggered when a member is reported.
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @permissionId MEMBERS.REPORTS_READ
+ * @webhook
+ * @eventType wix.members.v1.member_report_created
+ * @serviceIdentifier com.wixpress.members.memberreports.MemberReports
+ * @slug created
+ * @documentationMaturity preview
+ */
+export declare function onMemberReportCreated(handler: (event: MemberReportCreatedEnvelope) => void | Promise<void>): void;
+export interface MemberReportDeletedEnvelope {
     metadata: EventMetadata;
 }
-interface MemberReportReportedMemberCreatedEnvelope {
+/**
+ * Triggered when a report is deleted.
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @permissionId MEMBERS.REPORTS_READ
+ * @webhook
+ * @eventType wix.members.v1.member_report_deleted
+ * @serviceIdentifier com.wixpress.members.memberreports.MemberReports
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+export declare function onMemberReportDeleted(handler: (event: MemberReportDeletedEnvelope) => void | Promise<void>): void;
+export interface MemberReportReportedMemberCreatedEnvelope {
     data: ReportedMemberCreated;
     metadata: EventMetadata;
 }
-interface MemberReportReportedMemberDeletedEnvelope {
+/** @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @permissionId MEMBERS.REPORTS_READ
+ * @webhook
+ * @eventType wix.members.v1.member_report_reported_member_created
+ * @serviceIdentifier com.wixpress.members.memberreports.MemberReports
+ * @slug reported_member_created
+ * @documentationMaturity preview
+ */
+export declare function onMemberReportReportedMemberCreated(handler: (event: MemberReportReportedMemberCreatedEnvelope) => void | Promise<void>): void;
+export interface MemberReportReportedMemberDeletedEnvelope {
     data: ReportedMemberDeleted;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @permissionId MEMBERS.REPORTS_READ
+ * @webhook
+ * @eventType wix.members.v1.member_report_reported_member_deleted
+ * @serviceIdentifier com.wixpress.members.memberreports.MemberReports
+ * @slug reported_member_deleted
+ * @documentationMaturity preview
+ */
+export declare function onMemberReportReportedMemberDeleted(handler: (event: MemberReportReportedMemberDeletedEnvelope) => void | Promise<void>): void;
+type MemberReportNonNullablePaths = `reportedMemberId` | `reason.category`;
+/**
+ * Creates a report for the reported member.
+ * @param memberReport - Details of a member to report.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField memberReport
+ * @requiredField memberReport.reason
+ * @requiredField memberReport.reportedMemberId
+ * @permissionId MEMBERS.REPORTS_WRITE
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.members.memberreports.MemberReports.ReportMember
+ */
+export declare function reportMember(memberReport: NonNullablePaths<MemberReport, `reason` | `reportedMemberId`>): Promise<NonNullablePaths<ReportMemberResponse, {
+    [P in MemberReportNonNullablePaths]: `memberReport.${P}`;
+}[MemberReportNonNullablePaths]>>;
+/**
+ * Creates a query to retrieve a list of events.
+ *
+ * The `queryMemberReports()` method builds a query to retrieve a list of member reports and returns a [`MemberReportsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/members/member-report/member-reports-query-builder/eq) object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/members/member-report/member-reports-query-builder/find) method.
+ *
+ * You can refine the query by chaining `MemberReportsQueryBuilder` methods onto the query. `MemberReportsQueryBuilder` methods enable you to sort, filter, and control the results `queryMemberReports()` returns.
+ *
+ * `queryMemberReports()` runs with these `MemberReportsQueryBuilder` defaults, which you can override:
+ *
+ * - [limit(50)](https://dev.wix.com/docs/sdk/backend-modules/members/member-report/member-reports-query-builder/limit)
+ *
+ * The methods that are chained to `queryMemberReports()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('reportedMemberId'), the results are sorted first by the status, and then, if there are multiple results with the same title, the items are sorted by reported member ID.
+ * @public
+ * @documentationMaturity preview
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @permissionId MEMBERS.REPORTS_READ
+ * @applicableIdentity APP
+ * @fqn com.wixpress.members.memberreports.MemberReports.QueryMemberReports
+ */
+export declare function queryMemberReports(): MemberReportsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -434,13 +518,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface MemberReportsQueryResult extends QueryCursorResult {
+export interface MemberReportsQueryResult extends QueryCursorResult {
     items: MemberReport[];
     query: MemberReportsQueryBuilder;
     next: () => Promise<MemberReportsQueryResult>;
     prev: () => Promise<MemberReportsQueryResult>;
 }
-interface MemberReportsQueryBuilder {
+export interface MemberReportsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -496,18 +580,66 @@ interface MemberReportsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<MemberReportsQueryResult>;
 }
-interface ListReportedMembersOptions extends ListReportedMembersOptionsPagingMethodOneOf {
+/**
+ * Retrieves a list of reported members.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId MEMBERS.REPORTS_READ
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.members.memberreports.MemberReports.ListReportedMembers
+ * @deprecated
+ * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
+ * @targetRemovalDate 2025-01-31
+ */
+export declare function listReportedMembers(options?: ListReportedMembersOptions): Promise<NonNullablePaths<ListReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
+export interface ListReportedMembersOptions extends ListReportedMembersOptionsPagingMethodOneOf {
     /** 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;
 }
 /** @oneof */
-interface ListReportedMembersOptionsPagingMethodOneOf {
+export interface ListReportedMembersOptionsPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface QueryReportedMembersOptions {
+/**
+ * Retrieves a list of reported members, given the provided paging, filtering, and sorting.
+ *
+ * Query Reported Members runs with these defaults, which you can override:
+ * - `createdDate` is sorted in `ASC` order
+ * - `paging.limit` is `100`
+ * - `paging.offset` is `0`
+ *
+ * For field support for filters and sorting, see [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), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId MEMBERS.REPORTS_READ
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.members.memberreports.MemberReports.QueryReportedMembers
+ * @deprecated
+ * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
+ * @targetRemovalDate 2025-01-31
+ */
+export declare function queryReportedMembers(options?: QueryReportedMembersOptions): Promise<NonNullablePaths<QueryReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
+export interface QueryReportedMembersOptions {
     /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     query?: QueryV2;
 }
-
-export { type EntityUpdatedEvent as A, type EntityDeletedEvent as B, Category as C, type DeleteMemberReportsRequest as D, type EntityCreatedEvent as E, type ActionEvent as F, type Empty as G, type MessageEnvelope as H, type IdentificationData as I, type IdentificationDataIdOneOf as J, type BaseEventMetadata as K, type ListReportedMembersOptions as L, type MemberReport as M, type EventMetadata as N, type MemberReportCreatedEnvelope as O, type PagingMetadataV2 as P, type QueryReportedMembersOptions as Q, type ReportMemberResponse as R, SortOrder as S, type MemberReportDeletedEnvelope as T, type MemberReportReportedMemberCreatedEnvelope as U, type MemberReportReportedMemberDeletedEnvelope as V, WebhookIdentityType as W, type MemberReportsQueryResult as X, type ListReportedMembersOptionsPagingMethodOneOf as Y, type MemberReportsQueryBuilder as a, type ListReportedMembersResponse as b, type QueryReportedMembersResponse as c, type Reason as d, type ReportMemberRequest as e, type ReportedMemberCreated as f, type ReportedMember as g, type SelfReportingForbiddenError as h, type CannotReportBlockedMemberError as i, type QueryMemberReportsRequest as j, type QueryV2 as k, type Sorting as l, type CursorPaging as m, type QueryMemberReportsResponse as n, type Cursors as o, type MarkMemberReportsAsReviewedRequest as p, type MarkMemberReportsAsReviewedResponse as q, type ListReportedMembersRequest as r, type ListReportedMembersRequestPagingMethodOneOf as s, type Paging as t, type QueryReportedMembersRequest as u, type DeleteMemberReportsResponse as v, type ReportedMemberDeleted as w, type DomainEvent as x, type DomainEventBodyOneOf as y, type RestoreInfo as z };
+/**
+ * Deletes all reports of a member.
+ * @param memberId - ID of the member whose reports are to be deleted.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField memberId
+ * @permissionId MEMBERS.REPORTS_DELETE
+ * @permissionScope Manage Members
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.members.memberreports.MemberReports.DeleteMemberReports
+ */
+export declare function deleteMemberReports(memberId: string): Promise<void>;
+export {};