@wix/auto_sdk_members_member-report 1.0.10 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/members-v1-member-report-member-report.context.d.ts +26 -0
- package/build/cjs/src/members-v1-member-report-member-report.context.js +32 -0
- package/build/cjs/src/members-v1-member-report-member-report.context.js.map +1 -0
- package/build/cjs/src/members-v1-member-report-member-report.http.d.ts +39 -0
- package/build/cjs/src/members-v1-member-report-member-report.http.js +203 -0
- package/build/cjs/src/members-v1-member-report-member-report.http.js.map +1 -0
- package/build/cjs/src/members-v1-member-report-member-report.meta.d.ts +19 -0
- package/build/cjs/src/members-v1-member-report-member-report.meta.js +123 -0
- package/build/cjs/src/members-v1-member-report-member-report.meta.js.map +1 -0
- package/build/cjs/src/members-v1-member-report-member-report.public.d.ts +69 -0
- package/build/cjs/src/members-v1-member-report-member-report.public.js +77 -0
- package/build/cjs/src/members-v1-member-report-member-report.public.js.map +1 -0
- package/build/cjs/src/members-v1-member-report-member-report.types.d.ts +356 -0
- package/build/cjs/src/members-v1-member-report-member-report.types.js +30 -0
- package/build/cjs/src/members-v1-member-report-member-report.types.js.map +1 -0
- package/build/{internal/members-v1-member-report-member-report.universal-BBR1zWhW.d.mts → cjs/src/members-v1-member-report-member-report.universal.d.ts} +202 -86
- package/build/cjs/src/members-v1-member-report-member-report.universal.js +276 -0
- package/build/cjs/src/members-v1-member-report-member-report.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/members-v1-member-report-member-report.context.d.ts +26 -0
- package/build/es/src/members-v1-member-report-member-report.context.js +26 -0
- package/build/es/src/members-v1-member-report-member-report.context.js.map +1 -0
- package/build/es/src/members-v1-member-report-member-report.http.d.ts +39 -0
- package/build/es/src/members-v1-member-report-member-report.http.js +195 -0
- package/build/es/src/members-v1-member-report-member-report.http.js.map +1 -0
- package/build/es/src/members-v1-member-report-member-report.meta.d.ts +19 -0
- package/build/es/src/members-v1-member-report-member-report.meta.js +92 -0
- package/build/es/src/members-v1-member-report-member-report.meta.js.map +1 -0
- package/build/es/src/members-v1-member-report-member-report.public.d.ts +69 -0
- package/build/es/src/members-v1-member-report-member-report.public.js +66 -0
- package/build/es/src/members-v1-member-report-member-report.public.js.map +1 -0
- package/build/es/src/members-v1-member-report-member-report.types.d.ts +356 -0
- package/build/es/src/members-v1-member-report-member-report.types.js +27 -0
- package/build/es/src/members-v1-member-report-member-report.types.js.map +1 -0
- package/build/{internal/members-v1-member-report-member-report.universal-BBR1zWhW.d.ts → es/src/members-v1-member-report-member-report.universal.d.ts} +202 -86
- package/build/es/src/members-v1-member-report-member-report.universal.js +245 -0
- package/build/es/src/members-v1-member-report-member-report.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.context.d.ts +26 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.context.js +32 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.context.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.http.d.ts +39 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.http.js +203 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.http.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.meta.d.ts +19 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.meta.js +123 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.meta.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.public.d.ts +69 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.public.js +77 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.public.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.types.d.ts +356 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.types.js +30 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.types.js.map +1 -0
- package/build/{members-v1-member-report-member-report.universal-BBR1zWhW.d.mts → internal/cjs/src/members-v1-member-report-member-report.universal.d.ts} +202 -86
- package/build/internal/cjs/src/members-v1-member-report-member-report.universal.js +276 -0
- package/build/internal/cjs/src/members-v1-member-report-member-report.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/members-v1-member-report-member-report.context.d.ts +26 -0
- package/build/internal/es/src/members-v1-member-report-member-report.context.js +26 -0
- package/build/internal/es/src/members-v1-member-report-member-report.context.js.map +1 -0
- package/build/internal/es/src/members-v1-member-report-member-report.http.d.ts +39 -0
- package/build/internal/es/src/members-v1-member-report-member-report.http.js +195 -0
- package/build/internal/es/src/members-v1-member-report-member-report.http.js.map +1 -0
- package/build/internal/es/src/members-v1-member-report-member-report.meta.d.ts +19 -0
- package/build/internal/es/src/members-v1-member-report-member-report.meta.js +92 -0
- package/build/internal/es/src/members-v1-member-report-member-report.meta.js.map +1 -0
- package/build/internal/es/src/members-v1-member-report-member-report.public.d.ts +69 -0
- package/build/internal/es/src/members-v1-member-report-member-report.public.js +66 -0
- package/build/internal/es/src/members-v1-member-report-member-report.public.js.map +1 -0
- package/build/internal/es/src/members-v1-member-report-member-report.types.d.ts +356 -0
- package/build/internal/es/src/members-v1-member-report-member-report.types.js +27 -0
- package/build/internal/es/src/members-v1-member-report-member-report.types.js.map +1 -0
- package/build/{members-v1-member-report-member-report.universal-BBR1zWhW.d.ts → internal/es/src/members-v1-member-report-member-report.universal.d.ts} +202 -86
- package/build/internal/es/src/members-v1-member-report-member-report.universal.js +245 -0
- package/build/internal/es/src/members-v1-member-report-member-report.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -84
- package/build/index.d.ts +0 -84
- package/build/index.js +0 -495
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -460
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -84
- package/build/internal/index.d.ts +0 -84
- package/build/internal/index.js +0 -495
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -460
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -201
- package/build/internal/meta.d.ts +0 -201
- package/build/internal/meta.js +0 -293
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -262
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -201
- package/build/meta.d.ts +0 -201
- package/build/meta.js +0 -293
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -262
- package/build/meta.mjs.map +0 -1
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WebhookIdentityType = exports.SortOrder = exports.Category = void 0;
|
|
4
|
+
var Category;
|
|
5
|
+
(function (Category) {
|
|
6
|
+
/** Unknown category. This value is unused. */
|
|
7
|
+
Category["UNKNOWN"] = "UNKNOWN";
|
|
8
|
+
/** The member is reported for spam. */
|
|
9
|
+
Category["SPAM"] = "SPAM";
|
|
10
|
+
/** The member is reported for impersonation. */
|
|
11
|
+
Category["IMPERSONATION"] = "IMPERSONATION";
|
|
12
|
+
/** The member is reported for harassment. */
|
|
13
|
+
Category["HARASSMENT"] = "HARASSMENT";
|
|
14
|
+
/** The member is reported for other reasons. */
|
|
15
|
+
Category["OTHER"] = "OTHER";
|
|
16
|
+
})(Category || (exports.Category = Category = {}));
|
|
17
|
+
var SortOrder;
|
|
18
|
+
(function (SortOrder) {
|
|
19
|
+
SortOrder["ASC"] = "ASC";
|
|
20
|
+
SortOrder["DESC"] = "DESC";
|
|
21
|
+
})(SortOrder || (exports.SortOrder = SortOrder = {}));
|
|
22
|
+
var WebhookIdentityType;
|
|
23
|
+
(function (WebhookIdentityType) {
|
|
24
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
25
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
26
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
27
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
28
|
+
WebhookIdentityType["APP"] = "APP";
|
|
29
|
+
})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
|
|
30
|
+
//# sourceMappingURL=members-v1-member-report-member-report.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"members-v1-member-report-member-report.types.js","sourceRoot":"","sources":["../../../../src/members-v1-member-report-member-report.types.ts"],"names":[],"mappings":";;;AAiCA,IAAY,QAWX;AAXD,WAAY,QAAQ;IAClB,8CAA8C;IAC9C,+BAAmB,CAAA;IACnB,uCAAuC;IACvC,yBAAa,CAAA;IACb,gDAAgD;IAChD,2CAA+B,CAAA;IAC/B,6CAA6C;IAC7C,qCAAyB,CAAA;IACzB,gDAAgD;IAChD,2BAAe,CAAA;AACjB,CAAC,EAXW,QAAQ,wBAAR,QAAQ,QAWnB;AAsFD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA8PD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface MemberReport {
|
|
2
3
|
/**
|
|
3
4
|
* Report ID.
|
|
4
5
|
* @format GUID
|
|
@@ -23,13 +24,13 @@ interface MemberReport {
|
|
|
23
24
|
*/
|
|
24
25
|
_createdDate?: Date | null;
|
|
25
26
|
}
|
|
26
|
-
interface Reason {
|
|
27
|
+
export interface Reason {
|
|
27
28
|
/** Report reason type. */
|
|
28
29
|
category?: Category;
|
|
29
30
|
/** Explanation of why the member is being reported. */
|
|
30
31
|
description?: string | null;
|
|
31
32
|
}
|
|
32
|
-
declare enum Category {
|
|
33
|
+
export declare enum Category {
|
|
33
34
|
/** Unknown category. This value is unused. */
|
|
34
35
|
UNKNOWN = "UNKNOWN",
|
|
35
36
|
/** The member is reported for spam. */
|
|
@@ -41,19 +42,19 @@ declare enum Category {
|
|
|
41
42
|
/** The member is reported for other reasons. */
|
|
42
43
|
OTHER = "OTHER"
|
|
43
44
|
}
|
|
44
|
-
interface ReportMemberRequest {
|
|
45
|
+
export interface ReportMemberRequest {
|
|
45
46
|
/** Details of a member to report. */
|
|
46
47
|
memberReport: MemberReport;
|
|
47
48
|
}
|
|
48
|
-
interface ReportMemberResponse {
|
|
49
|
+
export interface ReportMemberResponse {
|
|
49
50
|
/** Member report. */
|
|
50
51
|
memberReport?: MemberReport;
|
|
51
52
|
}
|
|
52
|
-
interface ReportedMemberCreated {
|
|
53
|
+
export interface ReportedMemberCreated {
|
|
53
54
|
reportedMember?: ReportedMember;
|
|
54
55
|
}
|
|
55
56
|
/** Reported member details. */
|
|
56
|
-
interface ReportedMember {
|
|
57
|
+
export interface ReportedMember {
|
|
57
58
|
/**
|
|
58
59
|
* ID of the reported member.
|
|
59
60
|
* @format GUID
|
|
@@ -69,25 +70,25 @@ interface ReportedMember {
|
|
|
69
70
|
*/
|
|
70
71
|
lastReportDate?: Date | null;
|
|
71
72
|
}
|
|
72
|
-
interface SelfReportingForbiddenError {
|
|
73
|
+
export interface SelfReportingForbiddenError {
|
|
73
74
|
/**
|
|
74
75
|
* ID of the member that is reported.
|
|
75
76
|
* @format GUID
|
|
76
77
|
*/
|
|
77
78
|
memberId?: string;
|
|
78
79
|
}
|
|
79
|
-
interface CannotReportBlockedMemberError {
|
|
80
|
+
export interface CannotReportBlockedMemberError {
|
|
80
81
|
/**
|
|
81
82
|
* ID of the member that is reported.
|
|
82
83
|
* @format GUID
|
|
83
84
|
*/
|
|
84
85
|
memberId?: string;
|
|
85
86
|
}
|
|
86
|
-
interface QueryMemberReportsRequest {
|
|
87
|
+
export interface QueryMemberReportsRequest {
|
|
87
88
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
88
89
|
query?: QueryV2;
|
|
89
90
|
}
|
|
90
|
-
interface QueryV2 {
|
|
91
|
+
export interface QueryV2 {
|
|
91
92
|
/**
|
|
92
93
|
* Filter object in the following format:
|
|
93
94
|
* `"filter" : {
|
|
@@ -107,7 +108,7 @@ interface QueryV2 {
|
|
|
107
108
|
/** Paging options to limit and skip the number of items. */
|
|
108
109
|
paging?: CursorPaging;
|
|
109
110
|
}
|
|
110
|
-
interface Sorting {
|
|
111
|
+
export interface Sorting {
|
|
111
112
|
/**
|
|
112
113
|
* Name of the field to sort by.
|
|
113
114
|
* @maxLength 512
|
|
@@ -116,11 +117,11 @@ interface Sorting {
|
|
|
116
117
|
/** Sort order. */
|
|
117
118
|
order?: SortOrder;
|
|
118
119
|
}
|
|
119
|
-
declare enum SortOrder {
|
|
120
|
+
export declare enum SortOrder {
|
|
120
121
|
ASC = "ASC",
|
|
121
122
|
DESC = "DESC"
|
|
122
123
|
}
|
|
123
|
-
interface CursorPaging {
|
|
124
|
+
export interface CursorPaging {
|
|
124
125
|
/**
|
|
125
126
|
* The number of items to load.
|
|
126
127
|
* Default: `100`
|
|
@@ -130,13 +131,13 @@ interface CursorPaging {
|
|
|
130
131
|
/** 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`. */
|
|
131
132
|
cursor?: string | null;
|
|
132
133
|
}
|
|
133
|
-
interface QueryMemberReportsResponse {
|
|
134
|
+
export interface QueryMemberReportsResponse {
|
|
134
135
|
/** Retrieved member reports. */
|
|
135
136
|
memberReports?: MemberReport[];
|
|
136
137
|
/** Metadata for the paginated results. */
|
|
137
138
|
pagingMetadata?: PagingMetadataV2;
|
|
138
139
|
}
|
|
139
|
-
interface PagingMetadataV2 {
|
|
140
|
+
export interface PagingMetadataV2 {
|
|
140
141
|
/** Number of items returned in the response. */
|
|
141
142
|
count?: number | null;
|
|
142
143
|
/** Offset that was requested. */
|
|
@@ -148,7 +149,7 @@ interface PagingMetadataV2 {
|
|
|
148
149
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
149
150
|
cursors?: Cursors;
|
|
150
151
|
}
|
|
151
|
-
interface Cursors {
|
|
152
|
+
export interface Cursors {
|
|
152
153
|
/**
|
|
153
154
|
* Cursor string pointing to the next page in the list of results.
|
|
154
155
|
* @maxLength 16000
|
|
@@ -160,27 +161,27 @@ interface Cursors {
|
|
|
160
161
|
*/
|
|
161
162
|
prev?: string | null;
|
|
162
163
|
}
|
|
163
|
-
interface MarkMemberReportsAsReviewedRequest {
|
|
164
|
+
export interface MarkMemberReportsAsReviewedRequest {
|
|
164
165
|
/**
|
|
165
166
|
* ID of the member whose reports are to be marked as reviewed.
|
|
166
167
|
* @format GUID
|
|
167
168
|
*/
|
|
168
169
|
memberId?: string;
|
|
169
170
|
}
|
|
170
|
-
interface MarkMemberReportsAsReviewedResponse {
|
|
171
|
+
export interface MarkMemberReportsAsReviewedResponse {
|
|
171
172
|
/** Reported member details. */
|
|
172
173
|
reportedMember?: ReportedMember;
|
|
173
174
|
}
|
|
174
|
-
interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
|
|
175
|
+
export interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
|
|
175
176
|
/** 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`. */
|
|
176
177
|
cursorPaging?: CursorPaging;
|
|
177
178
|
}
|
|
178
179
|
/** @oneof */
|
|
179
|
-
interface ListReportedMembersRequestPagingMethodOneOf {
|
|
180
|
+
export interface ListReportedMembersRequestPagingMethodOneOf {
|
|
180
181
|
/** 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`. */
|
|
181
182
|
cursorPaging?: CursorPaging;
|
|
182
183
|
}
|
|
183
|
-
interface Paging {
|
|
184
|
+
export interface Paging {
|
|
184
185
|
/**
|
|
185
186
|
* Number of items to load.
|
|
186
187
|
* @max 100
|
|
@@ -189,59 +190,55 @@ interface Paging {
|
|
|
189
190
|
/** Number of items to skip in the current sort order. */
|
|
190
191
|
offset?: number | null;
|
|
191
192
|
}
|
|
192
|
-
interface ListReportedMembersResponse {
|
|
193
|
+
export interface ListReportedMembersResponse {
|
|
193
194
|
/** Retrieved reported members. */
|
|
194
195
|
reportedMembers?: ReportedMember[];
|
|
195
196
|
/** Metadata for the paginated results. */
|
|
196
197
|
pagingMetadata?: PagingMetadataV2;
|
|
197
198
|
}
|
|
198
|
-
interface QueryReportedMembersRequest {
|
|
199
|
+
export interface QueryReportedMembersRequest {
|
|
199
200
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
200
201
|
query?: QueryV2;
|
|
201
202
|
}
|
|
202
|
-
interface QueryReportedMembersResponse {
|
|
203
|
+
export interface QueryReportedMembersResponse {
|
|
203
204
|
/** Retrieved reported members. */
|
|
204
205
|
reportedMembers?: ReportedMember[];
|
|
205
206
|
/** Metadata for the paginated results. */
|
|
206
207
|
pagingMetadata?: PagingMetadataV2;
|
|
207
208
|
}
|
|
208
|
-
interface DeleteMemberReportsRequest {
|
|
209
|
+
export interface DeleteMemberReportsRequest {
|
|
209
210
|
/**
|
|
210
211
|
* ID of the member whose reports are to be deleted.
|
|
211
212
|
* @format GUID
|
|
212
213
|
*/
|
|
213
214
|
memberId: string;
|
|
214
215
|
}
|
|
215
|
-
interface DeleteMemberReportsResponse {
|
|
216
|
+
export interface DeleteMemberReportsResponse {
|
|
216
217
|
}
|
|
217
|
-
interface ReportedMemberDeleted {
|
|
218
|
+
export interface ReportedMemberDeleted {
|
|
218
219
|
/** @format GUID */
|
|
219
220
|
reportedMemberId?: string;
|
|
220
221
|
}
|
|
221
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
222
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
222
223
|
createdEvent?: EntityCreatedEvent;
|
|
223
224
|
updatedEvent?: EntityUpdatedEvent;
|
|
224
225
|
deletedEvent?: EntityDeletedEvent;
|
|
225
226
|
actionEvent?: ActionEvent;
|
|
226
|
-
/**
|
|
227
|
-
* Unique event ID.
|
|
228
|
-
* Allows clients to ignore duplicate webhooks.
|
|
229
|
-
*/
|
|
227
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
230
228
|
_id?: string;
|
|
231
229
|
/**
|
|
232
|
-
*
|
|
233
|
-
*
|
|
230
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
231
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
234
232
|
*/
|
|
235
233
|
entityFqdn?: string;
|
|
236
234
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
235
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
236
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
240
237
|
*/
|
|
241
238
|
slug?: string;
|
|
242
239
|
/** ID of the entity associated with the event. */
|
|
243
240
|
entityId?: string;
|
|
244
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
241
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
245
242
|
eventTime?: Date | null;
|
|
246
243
|
/**
|
|
247
244
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -251,29 +248,25 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
251
248
|
/** If present, indicates the action that triggered the event. */
|
|
252
249
|
originatedFrom?: string | null;
|
|
253
250
|
/**
|
|
254
|
-
* A sequence number
|
|
255
|
-
*
|
|
256
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
257
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
258
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
259
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
251
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
252
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
260
253
|
*/
|
|
261
254
|
entityEventSequence?: string | null;
|
|
262
255
|
}
|
|
263
256
|
/** @oneof */
|
|
264
|
-
interface DomainEventBodyOneOf {
|
|
257
|
+
export interface DomainEventBodyOneOf {
|
|
265
258
|
createdEvent?: EntityCreatedEvent;
|
|
266
259
|
updatedEvent?: EntityUpdatedEvent;
|
|
267
260
|
deletedEvent?: EntityDeletedEvent;
|
|
268
261
|
actionEvent?: ActionEvent;
|
|
269
262
|
}
|
|
270
|
-
interface EntityCreatedEvent {
|
|
263
|
+
export interface EntityCreatedEvent {
|
|
271
264
|
entity?: string;
|
|
272
265
|
}
|
|
273
|
-
interface RestoreInfo {
|
|
266
|
+
export interface RestoreInfo {
|
|
274
267
|
deletedDate?: Date | null;
|
|
275
268
|
}
|
|
276
|
-
interface EntityUpdatedEvent {
|
|
269
|
+
export interface EntityUpdatedEvent {
|
|
277
270
|
/**
|
|
278
271
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
279
272
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -281,16 +274,16 @@ interface EntityUpdatedEvent {
|
|
|
281
274
|
*/
|
|
282
275
|
currentEntity?: string;
|
|
283
276
|
}
|
|
284
|
-
interface EntityDeletedEvent {
|
|
285
|
-
/** Entity that was deleted */
|
|
277
|
+
export interface EntityDeletedEvent {
|
|
278
|
+
/** Entity that was deleted. */
|
|
286
279
|
deletedEntity?: string | null;
|
|
287
280
|
}
|
|
288
|
-
interface ActionEvent {
|
|
281
|
+
export interface ActionEvent {
|
|
289
282
|
body?: string;
|
|
290
283
|
}
|
|
291
|
-
interface Empty {
|
|
284
|
+
export interface Empty {
|
|
292
285
|
}
|
|
293
|
-
interface MessageEnvelope {
|
|
286
|
+
export interface MessageEnvelope {
|
|
294
287
|
/**
|
|
295
288
|
* App instance ID.
|
|
296
289
|
* @format GUID
|
|
@@ -306,7 +299,7 @@ interface MessageEnvelope {
|
|
|
306
299
|
/** Stringify payload. */
|
|
307
300
|
data?: string;
|
|
308
301
|
}
|
|
309
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
302
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
310
303
|
/**
|
|
311
304
|
* ID of a site visitor that has not logged in to the site.
|
|
312
305
|
* @format GUID
|
|
@@ -331,7 +324,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
331
324
|
identityType?: WebhookIdentityType;
|
|
332
325
|
}
|
|
333
326
|
/** @oneof */
|
|
334
|
-
interface IdentificationDataIdOneOf {
|
|
327
|
+
export interface IdentificationDataIdOneOf {
|
|
335
328
|
/**
|
|
336
329
|
* ID of a site visitor that has not logged in to the site.
|
|
337
330
|
* @format GUID
|
|
@@ -353,14 +346,14 @@ interface IdentificationDataIdOneOf {
|
|
|
353
346
|
*/
|
|
354
347
|
appId?: string;
|
|
355
348
|
}
|
|
356
|
-
declare enum WebhookIdentityType {
|
|
349
|
+
export declare enum WebhookIdentityType {
|
|
357
350
|
UNKNOWN = "UNKNOWN",
|
|
358
351
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
359
352
|
MEMBER = "MEMBER",
|
|
360
353
|
WIX_USER = "WIX_USER",
|
|
361
354
|
APP = "APP"
|
|
362
355
|
}
|
|
363
|
-
interface BaseEventMetadata {
|
|
356
|
+
export interface BaseEventMetadata {
|
|
364
357
|
/**
|
|
365
358
|
* App instance ID.
|
|
366
359
|
* @format GUID
|
|
@@ -374,26 +367,22 @@ interface BaseEventMetadata {
|
|
|
374
367
|
/** The identification type and identity data. */
|
|
375
368
|
identity?: IdentificationData;
|
|
376
369
|
}
|
|
377
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
378
|
-
/**
|
|
379
|
-
* Unique event ID.
|
|
380
|
-
* Allows clients to ignore duplicate webhooks.
|
|
381
|
-
*/
|
|
370
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
371
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
382
372
|
_id?: string;
|
|
383
373
|
/**
|
|
384
|
-
*
|
|
385
|
-
*
|
|
374
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
375
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
386
376
|
*/
|
|
387
377
|
entityFqdn?: string;
|
|
388
378
|
/**
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
379
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
380
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
392
381
|
*/
|
|
393
382
|
slug?: string;
|
|
394
383
|
/** ID of the entity associated with the event. */
|
|
395
384
|
entityId?: string;
|
|
396
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
385
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
397
386
|
eventTime?: Date | null;
|
|
398
387
|
/**
|
|
399
388
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -403,30 +392,109 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
403
392
|
/** If present, indicates the action that triggered the event. */
|
|
404
393
|
originatedFrom?: string | null;
|
|
405
394
|
/**
|
|
406
|
-
* A sequence number
|
|
407
|
-
*
|
|
408
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
409
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
410
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
411
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
395
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
396
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
412
397
|
*/
|
|
413
398
|
entityEventSequence?: string | null;
|
|
414
399
|
}
|
|
415
|
-
interface MemberReportCreatedEnvelope {
|
|
400
|
+
export interface MemberReportCreatedEnvelope {
|
|
416
401
|
entity: MemberReport;
|
|
417
402
|
metadata: EventMetadata;
|
|
418
403
|
}
|
|
419
|
-
|
|
404
|
+
/**
|
|
405
|
+
* Triggered when a member is reported.
|
|
406
|
+
* @permissionScope Manage Members
|
|
407
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
408
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
409
|
+
* @webhook
|
|
410
|
+
* @eventType wix.members.v1.member_report_created
|
|
411
|
+
* @serviceIdentifier com.wixpress.members.memberreports.MemberReports
|
|
412
|
+
* @slug created
|
|
413
|
+
* @documentationMaturity preview
|
|
414
|
+
*/
|
|
415
|
+
export declare function onMemberReportCreated(handler: (event: MemberReportCreatedEnvelope) => void | Promise<void>): void;
|
|
416
|
+
export interface MemberReportDeletedEnvelope {
|
|
420
417
|
metadata: EventMetadata;
|
|
421
418
|
}
|
|
422
|
-
|
|
419
|
+
/**
|
|
420
|
+
* Triggered when a report is deleted.
|
|
421
|
+
* @permissionScope Manage Members
|
|
422
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
423
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
424
|
+
* @webhook
|
|
425
|
+
* @eventType wix.members.v1.member_report_deleted
|
|
426
|
+
* @serviceIdentifier com.wixpress.members.memberreports.MemberReports
|
|
427
|
+
* @slug deleted
|
|
428
|
+
* @documentationMaturity preview
|
|
429
|
+
*/
|
|
430
|
+
export declare function onMemberReportDeleted(handler: (event: MemberReportDeletedEnvelope) => void | Promise<void>): void;
|
|
431
|
+
export interface MemberReportReportedMemberCreatedEnvelope {
|
|
423
432
|
data: ReportedMemberCreated;
|
|
424
433
|
metadata: EventMetadata;
|
|
425
434
|
}
|
|
426
|
-
|
|
435
|
+
/** @permissionScope Manage Members
|
|
436
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
437
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
438
|
+
* @webhook
|
|
439
|
+
* @eventType wix.members.v1.member_report_reported_member_created
|
|
440
|
+
* @serviceIdentifier com.wixpress.members.memberreports.MemberReports
|
|
441
|
+
* @slug reported_member_created
|
|
442
|
+
* @documentationMaturity preview
|
|
443
|
+
*/
|
|
444
|
+
export declare function onMemberReportReportedMemberCreated(handler: (event: MemberReportReportedMemberCreatedEnvelope) => void | Promise<void>): void;
|
|
445
|
+
export interface MemberReportReportedMemberDeletedEnvelope {
|
|
427
446
|
data: ReportedMemberDeleted;
|
|
428
447
|
metadata: EventMetadata;
|
|
429
448
|
}
|
|
449
|
+
/** @permissionScope Manage Members
|
|
450
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
451
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
452
|
+
* @webhook
|
|
453
|
+
* @eventType wix.members.v1.member_report_reported_member_deleted
|
|
454
|
+
* @serviceIdentifier com.wixpress.members.memberreports.MemberReports
|
|
455
|
+
* @slug reported_member_deleted
|
|
456
|
+
* @documentationMaturity preview
|
|
457
|
+
*/
|
|
458
|
+
export declare function onMemberReportReportedMemberDeleted(handler: (event: MemberReportReportedMemberDeletedEnvelope) => void | Promise<void>): void;
|
|
459
|
+
type MemberReportNonNullablePaths = `reportedMemberId` | `reason.category`;
|
|
460
|
+
/**
|
|
461
|
+
* Creates a report for the reported member.
|
|
462
|
+
* @param memberReport - Details of a member to report.
|
|
463
|
+
* @public
|
|
464
|
+
* @documentationMaturity preview
|
|
465
|
+
* @requiredField memberReport
|
|
466
|
+
* @requiredField memberReport.reason
|
|
467
|
+
* @requiredField memberReport.reportedMemberId
|
|
468
|
+
* @permissionId MEMBERS.REPORTS_WRITE
|
|
469
|
+
* @applicableIdentity MEMBER
|
|
470
|
+
* @fqn com.wixpress.members.memberreports.MemberReports.ReportMember
|
|
471
|
+
*/
|
|
472
|
+
export declare function reportMember(memberReport: NonNullablePaths<MemberReport, `reason` | `reportedMemberId`>): Promise<NonNullablePaths<ReportMemberResponse, {
|
|
473
|
+
[P in MemberReportNonNullablePaths]: `memberReport.${P}`;
|
|
474
|
+
}[MemberReportNonNullablePaths]>>;
|
|
475
|
+
/**
|
|
476
|
+
* Creates a query to retrieve a list of events.
|
|
477
|
+
*
|
|
478
|
+
* 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.
|
|
479
|
+
*
|
|
480
|
+
* 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.
|
|
481
|
+
*
|
|
482
|
+
* 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.
|
|
483
|
+
*
|
|
484
|
+
* `queryMemberReports()` runs with these `MemberReportsQueryBuilder` defaults, which you can override:
|
|
485
|
+
*
|
|
486
|
+
* - [limit(50)](https://dev.wix.com/docs/sdk/backend-modules/members/member-report/member-reports-query-builder/limit)
|
|
487
|
+
*
|
|
488
|
+
* 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.
|
|
489
|
+
* @public
|
|
490
|
+
* @documentationMaturity preview
|
|
491
|
+
* @permissionScope Manage Members
|
|
492
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
493
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
494
|
+
* @applicableIdentity APP
|
|
495
|
+
* @fqn com.wixpress.members.memberreports.MemberReports.QueryMemberReports
|
|
496
|
+
*/
|
|
497
|
+
export declare function queryMemberReports(): MemberReportsQueryBuilder;
|
|
430
498
|
interface QueryCursorResult {
|
|
431
499
|
cursors: Cursors;
|
|
432
500
|
hasNext: () => boolean;
|
|
@@ -434,13 +502,13 @@ interface QueryCursorResult {
|
|
|
434
502
|
length: number;
|
|
435
503
|
pageSize: number;
|
|
436
504
|
}
|
|
437
|
-
interface MemberReportsQueryResult extends QueryCursorResult {
|
|
505
|
+
export interface MemberReportsQueryResult extends QueryCursorResult {
|
|
438
506
|
items: MemberReport[];
|
|
439
507
|
query: MemberReportsQueryBuilder;
|
|
440
508
|
next: () => Promise<MemberReportsQueryResult>;
|
|
441
509
|
prev: () => Promise<MemberReportsQueryResult>;
|
|
442
510
|
}
|
|
443
|
-
interface MemberReportsQueryBuilder {
|
|
511
|
+
export interface MemberReportsQueryBuilder {
|
|
444
512
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
445
513
|
* @param value - Value to compare against.
|
|
446
514
|
* @documentationMaturity preview
|
|
@@ -496,18 +564,66 @@ interface MemberReportsQueryBuilder {
|
|
|
496
564
|
/** @documentationMaturity preview */
|
|
497
565
|
find: () => Promise<MemberReportsQueryResult>;
|
|
498
566
|
}
|
|
499
|
-
|
|
567
|
+
/**
|
|
568
|
+
* Retrieves a list of reported members.
|
|
569
|
+
* @public
|
|
570
|
+
* @documentationMaturity preview
|
|
571
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
572
|
+
* @permissionScope Manage Members
|
|
573
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
574
|
+
* @applicableIdentity APP
|
|
575
|
+
* @fqn com.wixpress.members.memberreports.MemberReports.ListReportedMembers
|
|
576
|
+
* @deprecated
|
|
577
|
+
* @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
|
|
578
|
+
* @targetRemovalDate 2025-01-31
|
|
579
|
+
*/
|
|
580
|
+
export declare function listReportedMembers(options?: ListReportedMembersOptions): Promise<NonNullablePaths<ListReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
|
|
581
|
+
export interface ListReportedMembersOptions extends ListReportedMembersOptionsPagingMethodOneOf {
|
|
500
582
|
/** 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`. */
|
|
501
583
|
cursorPaging?: CursorPaging;
|
|
502
584
|
}
|
|
503
585
|
/** @oneof */
|
|
504
|
-
interface ListReportedMembersOptionsPagingMethodOneOf {
|
|
586
|
+
export interface ListReportedMembersOptionsPagingMethodOneOf {
|
|
505
587
|
/** 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`. */
|
|
506
588
|
cursorPaging?: CursorPaging;
|
|
507
589
|
}
|
|
508
|
-
|
|
590
|
+
/**
|
|
591
|
+
* Retrieves a list of reported members, given the provided paging, filtering, and sorting.
|
|
592
|
+
*
|
|
593
|
+
* Query Reported Members runs with these defaults, which you can override:
|
|
594
|
+
* - `createdDate` is sorted in `ASC` order
|
|
595
|
+
* - `paging.limit` is `100`
|
|
596
|
+
* - `paging.offset` is `0`
|
|
597
|
+
*
|
|
598
|
+
* For field support for filters and sorting, see [Supported Filters and Sorting]().
|
|
599
|
+
* 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).
|
|
600
|
+
* @public
|
|
601
|
+
* @documentationMaturity preview
|
|
602
|
+
* @permissionId MEMBERS.REPORTS_READ
|
|
603
|
+
* @permissionScope Manage Members
|
|
604
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
605
|
+
* @applicableIdentity APP
|
|
606
|
+
* @fqn com.wixpress.members.memberreports.MemberReports.QueryReportedMembers
|
|
607
|
+
* @deprecated
|
|
608
|
+
* @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
|
|
609
|
+
* @targetRemovalDate 2025-01-31
|
|
610
|
+
*/
|
|
611
|
+
export declare function queryReportedMembers(options?: QueryReportedMembersOptions): Promise<NonNullablePaths<QueryReportedMembersResponse, `reportedMembers` | `reportedMembers.${number}.reportedMemberId` | `reportedMembers.${number}.reportCount` | `reportedMembers.${number}.reviewed`>>;
|
|
612
|
+
export interface QueryReportedMembersOptions {
|
|
509
613
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
510
614
|
query?: QueryV2;
|
|
511
615
|
}
|
|
512
|
-
|
|
513
|
-
|
|
616
|
+
/**
|
|
617
|
+
* Deletes all reports of a member.
|
|
618
|
+
* @param memberId - ID of the member whose reports are to be deleted.
|
|
619
|
+
* @public
|
|
620
|
+
* @documentationMaturity preview
|
|
621
|
+
* @requiredField memberId
|
|
622
|
+
* @permissionId MEMBERS.REPORTS_DELETE
|
|
623
|
+
* @permissionScope Manage Members
|
|
624
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
625
|
+
* @applicableIdentity APP
|
|
626
|
+
* @fqn com.wixpress.members.memberreports.MemberReports.DeleteMemberReports
|
|
627
|
+
*/
|
|
628
|
+
export declare function deleteMemberReports(memberId: string): Promise<void>;
|
|
629
|
+
export {};
|