@wix/auto_sdk_members_member-report 1.0.14 → 1.0.16

package/build/{cjs/src/members-v1-member-report-member-report.universal.d.ts → es/index.typings.d.mts}

@@ -1,5 +1,6 @@
 import { NonNullablePaths } from '@wix/sdk-types';
-export interface MemberReport {
+
+interface MemberReport {
     /**
      * Report ID.
      * @format GUID
@@ -24,13 +25,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 +44,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 +73,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 +111,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 +120,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 +136,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 +154,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 +166,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 +195,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 +259,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 +279,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 +304,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 +329,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 +351,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -358,8 +359,22 @@ 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';
+type ReportMemberApplicationErrors = {
+    code?: 'SELF_REPORTING_FORBIDDEN';
+    description?: string;
+    data?: SelfReportingForbiddenError;
+} | {
+    code?: 'CANNOT_REPORT_BLOCKED_MEMBER';
+    description?: string;
+    data?: CannotReportBlockedMemberError;
+};
+type DeleteMemberReportsApplicationErrors = {
+    code?: 'CANNOT_DELETE_MEMBER_REPORTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -373,7 +388,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,7 +418,7 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface MemberReportCreatedEnvelope {
+interface MemberReportCreatedEnvelope {
     entity: MemberReport;
     metadata: EventMetadata;
 }
@@ -418,8 +433,8 @@ export interface MemberReportCreatedEnvelope {
  * @slug created
  * @documentationMaturity preview
  */
-export declare function onMemberReportCreated(handler: (event: MemberReportCreatedEnvelope) => void | Promise<void>): void;
-export interface MemberReportDeletedEnvelope {
+declare function onMemberReportCreated(handler: (event: MemberReportCreatedEnvelope) => void | Promise<void>): void;
+interface MemberReportDeletedEnvelope {
     metadata: EventMetadata;
 }
 /**
@@ -433,8 +448,8 @@ export interface MemberReportDeletedEnvelope {
  * @slug deleted
  * @documentationMaturity preview
  */
-export declare function onMemberReportDeleted(handler: (event: MemberReportDeletedEnvelope) => void | Promise<void>): void;
-export interface MemberReportReportedMemberCreatedEnvelope {
+declare function onMemberReportDeleted(handler: (event: MemberReportDeletedEnvelope) => void | Promise<void>): void;
+interface MemberReportReportedMemberCreatedEnvelope {
     data: ReportedMemberCreated;
     metadata: EventMetadata;
 }
@@ -447,8 +462,8 @@ export interface MemberReportReportedMemberCreatedEnvelope {
  * @slug reported_member_created
  * @documentationMaturity preview
  */
-export declare function onMemberReportReportedMemberCreated(handler: (event: MemberReportReportedMemberCreatedEnvelope) => void | Promise<void>): void;
-export interface MemberReportReportedMemberDeletedEnvelope {
+declare function onMemberReportReportedMemberCreated(handler: (event: MemberReportReportedMemberCreatedEnvelope) => void | Promise<void>): void;
+interface MemberReportReportedMemberDeletedEnvelope {
     data: ReportedMemberDeleted;
     metadata: EventMetadata;
 }
@@ -461,7 +476,7 @@ export interface MemberReportReportedMemberDeletedEnvelope {
  * @slug reported_member_deleted
  * @documentationMaturity preview
  */
-export declare function onMemberReportReportedMemberDeleted(handler: (event: MemberReportReportedMemberDeletedEnvelope) => void | Promise<void>): void;
+declare function onMemberReportReportedMemberDeleted(handler: (event: MemberReportReportedMemberDeletedEnvelope) => void | Promise<void>): void;
 type MemberReportNonNullablePaths = `reportedMemberId` | `reason.category`;
 /**
  * Creates a report for the reported member.
@@ -475,9 +490,11 @@ type MemberReportNonNullablePaths = `reportedMemberId` | `reason.category`;
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.memberreports.MemberReports.ReportMember
  */
-export declare function reportMember(memberReport: NonNullablePaths<MemberReport, `reason` | `reportedMemberId`>): Promise<NonNullablePaths<ReportMemberResponse, {
+declare function reportMember(memberReport: NonNullablePaths<MemberReport, `reason` | `reportedMemberId`>): Promise<NonNullablePaths<ReportMemberResponse, {
     [P in MemberReportNonNullablePaths]: `memberReport.${P}`;
-}[MemberReportNonNullablePaths]>>;
+}[MemberReportNonNullablePaths]> & {
+    __applicationErrorsType?: ReportMemberApplicationErrors;
+}>;
 /**
  * Creates a query to retrieve a list of events.
  *
@@ -494,13 +511,11 @@ export declare function reportMember(memberReport: NonNullablePaths<MemberReport
  * 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;
+declare function queryMemberReports(): MemberReportsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -508,13 +523,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
@@ -575,21 +590,19 @@ export interface MemberReportsQueryBuilder {
  * @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 {
+declare function listReportedMembers(options?: ListReportedMembersOptions): Promise<NonNullablePaths<ListReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
+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;
 }
@@ -606,16 +619,14 @@ export interface ListReportedMembersOptionsPagingMethodOneOf {
  * @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 {
+declare function queryReportedMembers(options?: QueryReportedMembersOptions): Promise<NonNullablePaths<QueryReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
+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;
 }
@@ -626,10 +637,11 @@ export interface QueryReportedMembersOptions {
  * @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 {};
+declare function deleteMemberReports(memberId: string): Promise<void & {
+    __applicationErrorsType?: DeleteMemberReportsApplicationErrors;
+}>;
+
+export { type ActionEvent, type BaseEventMetadata, type CannotReportBlockedMemberError, Category, type CategoryWithLiterals, type CursorPaging, type Cursors, type DeleteMemberReportsApplicationErrors, type DeleteMemberReportsRequest, type DeleteMemberReportsResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type IdentificationData, type IdentificationDataIdOneOf, type ListReportedMembersOptions, type ListReportedMembersOptionsPagingMethodOneOf, type ListReportedMembersRequest, type ListReportedMembersRequestPagingMethodOneOf, type ListReportedMembersResponse, type MarkMemberReportsAsReviewedRequest, type MarkMemberReportsAsReviewedResponse, type MemberReport, type MemberReportCreatedEnvelope, type MemberReportDeletedEnvelope, type MemberReportReportedMemberCreatedEnvelope, type MemberReportReportedMemberDeletedEnvelope, type MemberReportsQueryBuilder, type MemberReportsQueryResult, type MessageEnvelope, type Paging, type PagingMetadataV2, type QueryMemberReportsRequest, type QueryMemberReportsResponse, type QueryReportedMembersOptions, type QueryReportedMembersRequest, type QueryReportedMembersResponse, type QueryV2, type Reason, type ReportMemberApplicationErrors, type ReportMemberRequest, type ReportMemberResponse, type ReportedMember, type ReportedMemberCreated, type ReportedMemberDeleted, type RestoreInfo, type SelfReportingForbiddenError, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, deleteMemberReports, listReportedMembers, onMemberReportCreated, onMemberReportDeleted, onMemberReportReportedMemberCreated, onMemberReportReportedMemberDeleted, queryMemberReports, queryReportedMembers, reportMember };