@wix/auto_sdk_members_member-report 1.0.13 → 1.0.15

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

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface MemberReport {
+interface MemberReport {
     /**
      * Report ID.
      * @format GUID
@@ -24,13 +23,13 @@ export interface MemberReport {
      */
     _createdDate?: Date | null;
 }
-export interface Reason {
+interface Reason {
     /** Report reason type. */
     category?: CategoryWithLiterals;
     /** Explanation of why the member is being reported. */
     description?: string | null;
 }
-export declare enum Category {
+declare enum Category {
     /** Unknown category. This value is unused. */
     UNKNOWN = "UNKNOWN",
     /** The member is reported for spam. */
@@ -43,20 +42,20 @@ export declare enum Category {
     OTHER = "OTHER"
 }
 /** @enumType */
-export type CategoryWithLiterals = Category | 'UNKNOWN' | 'SPAM' | 'IMPERSONATION' | 'HARASSMENT' | 'OTHER';
-export interface ReportMemberRequest {
+type CategoryWithLiterals = Category | 'UNKNOWN' | 'SPAM' | 'IMPERSONATION' | 'HARASSMENT' | 'OTHER';
+interface ReportMemberRequest {
     /** Details of a member to report. */
     memberReport: MemberReport;
 }
-export interface ReportMemberResponse {
+interface ReportMemberResponse {
     /** Member report. */
     memberReport?: MemberReport;
 }
-export interface ReportedMemberCreated {
+interface ReportedMemberCreated {
     reportedMember?: ReportedMember;
 }
 /** Reported member details. */
-export interface ReportedMember {
+interface ReportedMember {
     /**
      * ID of the reported member.
      * @format GUID
@@ -72,25 +71,25 @@ export interface ReportedMember {
      */
     lastReportDate?: Date | null;
 }
-export interface SelfReportingForbiddenError {
+interface SelfReportingForbiddenError {
     /**
      * ID of the member that is reported.
      * @format GUID
      */
     memberId?: string;
 }
-export interface CannotReportBlockedMemberError {
+interface CannotReportBlockedMemberError {
     /**
      * ID of the member that is reported.
      * @format GUID
      */
     memberId?: string;
 }
-export interface QueryMemberReportsRequest {
+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;
 }
-export interface QueryV2 {
+interface QueryV2 {
     /**
      * Filter object in the following format:
      * `"filter" : {
@@ -110,7 +109,7 @@ export interface QueryV2 {
     /** Paging options to limit and skip the number of items. */
     paging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -119,13 +118,13 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * The number of items to load.
      * Default: `100`
@@ -135,13 +134,13 @@ export 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;
 }
-export interface QueryMemberReportsResponse {
+interface QueryMemberReportsResponse {
     /** Retrieved member reports. */
     memberReports?: MemberReport[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -153,7 +152,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -165,27 +164,27 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface MarkMemberReportsAsReviewedRequest {
+interface MarkMemberReportsAsReviewedRequest {
     /**
      * ID of the member whose reports are to be marked as reviewed.
      * @format GUID
      */
     memberId?: string;
 }
-export interface MarkMemberReportsAsReviewedResponse {
+interface MarkMemberReportsAsReviewedResponse {
     /** Reported member details. */
     reportedMember?: ReportedMember;
 }
-export interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
+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 */
-export interface ListReportedMembersRequestPagingMethodOneOf {
+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;
 }
-export interface Paging {
+interface Paging {
     /**
      * Number of items to load.
      * @max 100
@@ -194,36 +193,36 @@ export interface Paging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface ListReportedMembersResponse {
+interface ListReportedMembersResponse {
     /** Retrieved reported members. */
     reportedMembers?: ReportedMember[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface QueryReportedMembersRequest {
+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;
 }
-export interface QueryReportedMembersResponse {
+interface QueryReportedMembersResponse {
     /** Retrieved reported members. */
     reportedMembers?: ReportedMember[];
     /** Metadata for the paginated results. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface DeleteMemberReportsRequest {
+interface DeleteMemberReportsRequest {
     /**
      * ID of the member whose reports are to be deleted.
      * @format GUID
      */
     memberId: string;
 }
-export interface DeleteMemberReportsResponse {
+interface DeleteMemberReportsResponse {
 }
-export interface ReportedMemberDeleted {
+interface ReportedMemberDeleted {
     /** @format GUID */
     reportedMemberId?: string;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -258,19 +257,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -278,16 +277,16 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -303,7 +302,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -328,7 +327,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -350,7 +349,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -358,8 +357,8 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -373,7 +372,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
@@ -403,104 +402,21 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface MemberReportCreatedEnvelope {
+interface MemberReportCreatedEnvelope {
     entity: MemberReport;
     metadata: EventMetadata;
 }
-/**
- * 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 {
+interface MemberReportDeletedEnvelope {
     metadata: EventMetadata;
 }
-/**
- * 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 {
+interface MemberReportReportedMemberCreatedEnvelope {
     data: ReportedMemberCreated;
     metadata: EventMetadata;
 }
-/** @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 {
+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;
@@ -508,13 +424,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface MemberReportsQueryResult extends QueryCursorResult {
+interface MemberReportsQueryResult extends QueryCursorResult {
     items: MemberReport[];
     query: MemberReportsQueryBuilder;
     next: () => Promise<MemberReportsQueryResult>;
     prev: () => Promise<MemberReportsQueryResult>;
 }
-export interface MemberReportsQueryBuilder {
+interface MemberReportsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -570,66 +486,18 @@ export interface MemberReportsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<MemberReportsQueryResult>;
 }
-/**
- * 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 {
+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 */
-export interface ListReportedMembersOptionsPagingMethodOneOf {
+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;
 }
-/**
- * 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 {
+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;
 }
-/**
- * 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 {};
+
+export { type ReportedMemberDeleted as A, type DomainEvent as B, Category as C, type DeleteMemberReportsRequest as D, type DomainEventBodyOneOf as E, type EntityCreatedEvent as F, type RestoreInfo as G, type EntityUpdatedEvent as H, type EntityDeletedEvent as I, type ActionEvent as J, type Empty as K, type ListReportedMembersOptions as L, type MemberReport as M, type MessageEnvelope as N, type IdentificationData as O, type PagingMetadataV2 as P, type QueryReportedMembersOptions as Q, type ReportMemberResponse as R, SortOrder as S, type IdentificationDataIdOneOf as T, type BaseEventMetadata as U, type EventMetadata 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 MemberReportCreatedEnvelope as d, type MemberReportDeletedEnvelope as e, type MemberReportReportedMemberCreatedEnvelope as f, type MemberReportReportedMemberDeletedEnvelope as g, type Reason as h, type ReportMemberRequest as i, type ReportedMemberCreated as j, type ReportedMember as k, type SelfReportingForbiddenError as l, type CannotReportBlockedMemberError as m, type QueryMemberReportsRequest as n, type QueryV2 as o, type Sorting as p, type CursorPaging as q, type QueryMemberReportsResponse as r, type Cursors as s, type MarkMemberReportsAsReviewedRequest as t, type MarkMemberReportsAsReviewedResponse as u, type ListReportedMembersRequest as v, type ListReportedMembersRequestPagingMethodOneOf as w, type Paging as x, type QueryReportedMembersRequest as y, type DeleteMemberReportsResponse as z };