@wix/auto_sdk_members_member-report 1.0.0

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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/members-v1-member-report-member-report.context.d.ts +26 -0
  11. package/build/cjs/src/members-v1-member-report-member-report.context.js +32 -0
  12. package/build/cjs/src/members-v1-member-report-member-report.context.js.map +1 -0
  13. package/build/cjs/src/members-v1-member-report-member-report.http.d.ts +39 -0
  14. package/build/cjs/src/members-v1-member-report-member-report.http.js +203 -0
  15. package/build/cjs/src/members-v1-member-report-member-report.http.js.map +1 -0
  16. package/build/cjs/src/members-v1-member-report-member-report.meta.d.ts +19 -0
  17. package/build/cjs/src/members-v1-member-report-member-report.meta.js +123 -0
  18. package/build/cjs/src/members-v1-member-report-member-report.meta.js.map +1 -0
  19. package/build/cjs/src/members-v1-member-report-member-report.public.d.ts +69 -0
  20. package/build/cjs/src/members-v1-member-report-member-report.public.js +77 -0
  21. package/build/cjs/src/members-v1-member-report-member-report.public.js.map +1 -0
  22. package/build/cjs/src/members-v1-member-report-member-report.types.d.ts +326 -0
  23. package/build/cjs/src/members-v1-member-report-member-report.types.js +30 -0
  24. package/build/cjs/src/members-v1-member-report-member-report.types.js.map +1 -0
  25. package/build/cjs/src/members-v1-member-report-member-report.universal.d.ts +583 -0
  26. package/build/cjs/src/members-v1-member-report-member-report.universal.js +274 -0
  27. package/build/cjs/src/members-v1-member-report-member-report.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/members-v1-member-report-member-report.context.d.ts +26 -0
  39. package/build/es/src/members-v1-member-report-member-report.context.js +26 -0
  40. package/build/es/src/members-v1-member-report-member-report.context.js.map +1 -0
  41. package/build/es/src/members-v1-member-report-member-report.http.d.ts +39 -0
  42. package/build/es/src/members-v1-member-report-member-report.http.js +195 -0
  43. package/build/es/src/members-v1-member-report-member-report.http.js.map +1 -0
  44. package/build/es/src/members-v1-member-report-member-report.meta.d.ts +19 -0
  45. package/build/es/src/members-v1-member-report-member-report.meta.js +92 -0
  46. package/build/es/src/members-v1-member-report-member-report.meta.js.map +1 -0
  47. package/build/es/src/members-v1-member-report-member-report.public.d.ts +69 -0
  48. package/build/es/src/members-v1-member-report-member-report.public.js +66 -0
  49. package/build/es/src/members-v1-member-report-member-report.public.js.map +1 -0
  50. package/build/es/src/members-v1-member-report-member-report.types.d.ts +326 -0
  51. package/build/es/src/members-v1-member-report-member-report.types.js +27 -0
  52. package/build/es/src/members-v1-member-report-member-report.types.js.map +1 -0
  53. package/build/es/src/members-v1-member-report-member-report.universal.d.ts +583 -0
  54. package/build/es/src/members-v1-member-report-member-report.universal.js +243 -0
  55. package/build/es/src/members-v1-member-report-member-report.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/members-v1-member-report-member-report.context.d.ts +26 -0
  66. package/build/internal/cjs/src/members-v1-member-report-member-report.context.js +32 -0
  67. package/build/internal/cjs/src/members-v1-member-report-member-report.context.js.map +1 -0
  68. package/build/internal/cjs/src/members-v1-member-report-member-report.http.d.ts +39 -0
  69. package/build/internal/cjs/src/members-v1-member-report-member-report.http.js +203 -0
  70. package/build/internal/cjs/src/members-v1-member-report-member-report.http.js.map +1 -0
  71. package/build/internal/cjs/src/members-v1-member-report-member-report.meta.d.ts +19 -0
  72. package/build/internal/cjs/src/members-v1-member-report-member-report.meta.js +123 -0
  73. package/build/internal/cjs/src/members-v1-member-report-member-report.meta.js.map +1 -0
  74. package/build/internal/cjs/src/members-v1-member-report-member-report.public.d.ts +69 -0
  75. package/build/internal/cjs/src/members-v1-member-report-member-report.public.js +77 -0
  76. package/build/internal/cjs/src/members-v1-member-report-member-report.public.js.map +1 -0
  77. package/build/internal/cjs/src/members-v1-member-report-member-report.types.d.ts +326 -0
  78. package/build/internal/cjs/src/members-v1-member-report-member-report.types.js +30 -0
  79. package/build/internal/cjs/src/members-v1-member-report-member-report.types.js.map +1 -0
  80. package/build/internal/cjs/src/members-v1-member-report-member-report.universal.d.ts +583 -0
  81. package/build/internal/cjs/src/members-v1-member-report-member-report.universal.js +274 -0
  82. package/build/internal/cjs/src/members-v1-member-report-member-report.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/members-v1-member-report-member-report.context.d.ts +26 -0
  93. package/build/internal/es/src/members-v1-member-report-member-report.context.js +26 -0
  94. package/build/internal/es/src/members-v1-member-report-member-report.context.js.map +1 -0
  95. package/build/internal/es/src/members-v1-member-report-member-report.http.d.ts +39 -0
  96. package/build/internal/es/src/members-v1-member-report-member-report.http.js +195 -0
  97. package/build/internal/es/src/members-v1-member-report-member-report.http.js.map +1 -0
  98. package/build/internal/es/src/members-v1-member-report-member-report.meta.d.ts +19 -0
  99. package/build/internal/es/src/members-v1-member-report-member-report.meta.js +92 -0
  100. package/build/internal/es/src/members-v1-member-report-member-report.meta.js.map +1 -0
  101. package/build/internal/es/src/members-v1-member-report-member-report.public.d.ts +69 -0
  102. package/build/internal/es/src/members-v1-member-report-member-report.public.js +66 -0
  103. package/build/internal/es/src/members-v1-member-report-member-report.public.js.map +1 -0
  104. package/build/internal/es/src/members-v1-member-report-member-report.types.d.ts +326 -0
  105. package/build/internal/es/src/members-v1-member-report-member-report.types.js +27 -0
  106. package/build/internal/es/src/members-v1-member-report-member-report.types.js.map +1 -0
  107. package/build/internal/es/src/members-v1-member-report-member-report.universal.d.ts +583 -0
  108. package/build/internal/es/src/members-v1-member-report-member-report.universal.js +243 -0
  109. package/build/internal/es/src/members-v1-member-report-member-report.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -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":";;;AA6BA,IAAY,QAWX;AAXD,WAAY,QAAQ;IAClB,6CAA6C;IAC7C,+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;AA0ED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAuND,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"}
@@ -0,0 +1,583 @@
1
+ export interface MemberReport {
2
+ /**
3
+ * Report ID.
4
+ * @readonly
5
+ */
6
+ _id?: string | null;
7
+ /** ID of the reported member. */
8
+ reportedMemberId?: string;
9
+ /**
10
+ * ID of the member who created the report.
11
+ * @readonly
12
+ */
13
+ reportingMemberId?: string | null;
14
+ /** Reason for reporting a member. */
15
+ reason?: Reason;
16
+ /**
17
+ * Date and time the report was created.
18
+ * @readonly
19
+ */
20
+ _createdDate?: Date | null;
21
+ }
22
+ export interface Reason {
23
+ /** Report reason type. */
24
+ category?: Category;
25
+ /** Why the member is reported. */
26
+ description?: string | null;
27
+ }
28
+ export declare enum Category {
29
+ /** Unknown category. This value is unused */
30
+ UNKNOWN = "UNKNOWN",
31
+ /** The member is reported for spam. */
32
+ SPAM = "SPAM",
33
+ /** The member is reported for impersonation. */
34
+ IMPERSONATION = "IMPERSONATION",
35
+ /** The member is reported for harassment. */
36
+ HARASSMENT = "HARASSMENT",
37
+ /** The member is reported for other reasons. */
38
+ OTHER = "OTHER"
39
+ }
40
+ export interface ReportMemberRequest {
41
+ /** Details of a member to report. */
42
+ memberReport: MemberReport;
43
+ }
44
+ export interface ReportMemberResponse {
45
+ /** Member report. */
46
+ memberReport?: MemberReport;
47
+ }
48
+ export interface ReportedMemberCreated {
49
+ reportedMember?: ReportedMember;
50
+ }
51
+ /** Reported member details. */
52
+ export interface ReportedMember {
53
+ /** ID of the reported member. */
54
+ reportedMemberId?: string;
55
+ /** Number of reports for this member. */
56
+ reportCount?: string;
57
+ /** Whether reports of this member have been reviewed. */
58
+ reviewed?: boolean;
59
+ /**
60
+ * Date and time when the most recent report was created.
61
+ * @readonly
62
+ */
63
+ lastReportDate?: Date | null;
64
+ }
65
+ export interface SelfReportingForbiddenError {
66
+ /** ID of the member that is reported. */
67
+ memberId?: string;
68
+ }
69
+ export interface CannotReportBlockedMemberError {
70
+ /** ID of the member that is reported. */
71
+ memberId?: string;
72
+ }
73
+ export interface QueryMemberReportsRequest {
74
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
75
+ query?: QueryV2;
76
+ }
77
+ export interface QueryV2 {
78
+ /**
79
+ * Filter object in the following format:
80
+ * `"filter" : {
81
+ * "fieldName1": "value1",
82
+ * "fieldName2":{"$operator":"value2"}
83
+ * }`
84
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
85
+ *
86
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
87
+ */
88
+ filter?: Record<string, any> | null;
89
+ /**
90
+ * Sort object in the following format:
91
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
92
+ */
93
+ sorting?: Sorting[];
94
+ /** Paging options to limit and skip the number of items. */
95
+ paging?: CursorPaging;
96
+ }
97
+ export interface Sorting {
98
+ /** Name of the field to sort by. */
99
+ fieldName?: string;
100
+ /** Sort order. */
101
+ order?: SortOrder;
102
+ }
103
+ export declare enum SortOrder {
104
+ ASC = "ASC",
105
+ DESC = "DESC"
106
+ }
107
+ export interface CursorPaging {
108
+ /**
109
+ * The number of items to load.
110
+ * Default: `100`
111
+ */
112
+ limit?: number | null;
113
+ /** 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`. */
114
+ cursor?: string | null;
115
+ }
116
+ export interface QueryMemberReportsResponse {
117
+ /** Retrieved member reports. */
118
+ memberReports?: MemberReport[];
119
+ /** Metadata for the paginated results. */
120
+ pagingMetadata?: PagingMetadataV2;
121
+ }
122
+ export interface PagingMetadataV2 {
123
+ /** Number of items returned in the response. */
124
+ count?: number | null;
125
+ /** Offset that was requested. */
126
+ offset?: number | null;
127
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
128
+ total?: number | null;
129
+ /** Flag that indicates the server failed to calculate the `total` field. */
130
+ tooManyToCount?: boolean | null;
131
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
132
+ cursors?: Cursors;
133
+ }
134
+ export interface Cursors {
135
+ /** Cursor string pointing to the next page in the list of results. */
136
+ next?: string | null;
137
+ /** Cursor pointing to the previous page in the list of results. */
138
+ prev?: string | null;
139
+ }
140
+ export interface MarkMemberReportsAsReviewedRequest {
141
+ /** ID of the member whose reports are to be marked as reviewed. */
142
+ memberId?: string;
143
+ }
144
+ export interface MarkMemberReportsAsReviewedResponse {
145
+ /** Reported member details. */
146
+ reportedMember?: ReportedMember;
147
+ }
148
+ export interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf {
149
+ /** 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`. */
150
+ cursorPaging?: CursorPaging;
151
+ }
152
+ /** @oneof */
153
+ export interface ListReportedMembersRequestPagingMethodOneOf {
154
+ /** 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`. */
155
+ cursorPaging?: CursorPaging;
156
+ }
157
+ export interface Paging {
158
+ /** Number of items to load. */
159
+ limit?: number | null;
160
+ /** Number of items to skip in the current sort order. */
161
+ offset?: number | null;
162
+ }
163
+ export interface ListReportedMembersResponse {
164
+ /** Retrieved reported members. */
165
+ reportedMembers?: ReportedMember[];
166
+ /** Metadata for the paginated results. */
167
+ pagingMetadata?: PagingMetadataV2;
168
+ }
169
+ export interface QueryReportedMembersRequest {
170
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
171
+ query?: QueryV2;
172
+ }
173
+ export interface QueryReportedMembersResponse {
174
+ /** Retrieved reported members. */
175
+ reportedMembers?: ReportedMember[];
176
+ /** Metadata for the paginated results. */
177
+ pagingMetadata?: PagingMetadataV2;
178
+ }
179
+ export interface DeleteMemberReportsRequest {
180
+ /** ID of the member whose reports to be deleted. */
181
+ memberId: string;
182
+ }
183
+ export interface DeleteMemberReportsResponse {
184
+ }
185
+ export interface ReportedMemberDeleted {
186
+ reportedMemberId?: string;
187
+ }
188
+ export interface DomainEvent extends DomainEventBodyOneOf {
189
+ createdEvent?: EntityCreatedEvent;
190
+ updatedEvent?: EntityUpdatedEvent;
191
+ deletedEvent?: EntityDeletedEvent;
192
+ actionEvent?: ActionEvent;
193
+ /**
194
+ * Unique event ID.
195
+ * Allows clients to ignore duplicate webhooks.
196
+ */
197
+ _id?: string;
198
+ /**
199
+ * Assumes actions are also always typed to an entity_type
200
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
201
+ */
202
+ entityFqdn?: string;
203
+ /**
204
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
205
+ * This is although the created/updated/deleted notion is duplication of the oneof types
206
+ * Example: created/updated/deleted/started/completed/email_opened
207
+ */
208
+ slug?: string;
209
+ /** ID of the entity associated with the event. */
210
+ entityId?: string;
211
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
212
+ eventTime?: Date | null;
213
+ /**
214
+ * Whether the event was triggered as a result of a privacy regulation application
215
+ * (for example, GDPR).
216
+ */
217
+ triggeredByAnonymizeRequest?: boolean | null;
218
+ /** If present, indicates the action that triggered the event. */
219
+ originatedFrom?: string | null;
220
+ /**
221
+ * A sequence number defining the order of updates to the underlying entity.
222
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
223
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
224
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
225
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
226
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
227
+ */
228
+ entityEventSequence?: string | null;
229
+ }
230
+ /** @oneof */
231
+ export interface DomainEventBodyOneOf {
232
+ createdEvent?: EntityCreatedEvent;
233
+ updatedEvent?: EntityUpdatedEvent;
234
+ deletedEvent?: EntityDeletedEvent;
235
+ actionEvent?: ActionEvent;
236
+ }
237
+ export interface EntityCreatedEvent {
238
+ entity?: string;
239
+ }
240
+ export interface RestoreInfo {
241
+ deletedDate?: Date | null;
242
+ }
243
+ export interface EntityUpdatedEvent {
244
+ /**
245
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
246
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
247
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
248
+ */
249
+ currentEntity?: string;
250
+ }
251
+ export interface EntityDeletedEvent {
252
+ /** Entity that was deleted */
253
+ deletedEntity?: string | null;
254
+ }
255
+ export interface ActionEvent {
256
+ body?: string;
257
+ }
258
+ export interface Empty {
259
+ }
260
+ export interface MessageEnvelope {
261
+ /** App instance ID. */
262
+ instanceId?: string | null;
263
+ /** Event type. */
264
+ eventType?: string;
265
+ /** The identification type and identity data. */
266
+ identity?: IdentificationData;
267
+ /** Stringify payload. */
268
+ data?: string;
269
+ }
270
+ export interface IdentificationData extends IdentificationDataIdOneOf {
271
+ /** ID of a site visitor that has not logged in to the site. */
272
+ anonymousVisitorId?: string;
273
+ /** ID of a site visitor that has logged in to the site. */
274
+ memberId?: string;
275
+ /** ID of a Wix user (site owner, contributor, etc.). */
276
+ wixUserId?: string;
277
+ /** ID of an app. */
278
+ appId?: string;
279
+ /** @readonly */
280
+ identityType?: WebhookIdentityType;
281
+ }
282
+ /** @oneof */
283
+ export interface IdentificationDataIdOneOf {
284
+ /** ID of a site visitor that has not logged in to the site. */
285
+ anonymousVisitorId?: string;
286
+ /** ID of a site visitor that has logged in to the site. */
287
+ memberId?: string;
288
+ /** ID of a Wix user (site owner, contributor, etc.). */
289
+ wixUserId?: string;
290
+ /** ID of an app. */
291
+ appId?: string;
292
+ }
293
+ export declare enum WebhookIdentityType {
294
+ UNKNOWN = "UNKNOWN",
295
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
296
+ MEMBER = "MEMBER",
297
+ WIX_USER = "WIX_USER",
298
+ APP = "APP"
299
+ }
300
+ interface ReasonNonNullableFields {
301
+ category: Category;
302
+ }
303
+ interface MemberReportNonNullableFields {
304
+ reportedMemberId: string;
305
+ reason?: ReasonNonNullableFields;
306
+ }
307
+ export interface ReportMemberResponseNonNullableFields {
308
+ memberReport?: MemberReportNonNullableFields;
309
+ }
310
+ export interface QueryMemberReportsResponseNonNullableFields {
311
+ memberReports: MemberReportNonNullableFields[];
312
+ }
313
+ interface ReportedMemberNonNullableFields {
314
+ reportedMemberId: string;
315
+ reportCount: string;
316
+ reviewed: boolean;
317
+ }
318
+ export interface ListReportedMembersResponseNonNullableFields {
319
+ reportedMembers: ReportedMemberNonNullableFields[];
320
+ }
321
+ export interface QueryReportedMembersResponseNonNullableFields {
322
+ reportedMembers: ReportedMemberNonNullableFields[];
323
+ }
324
+ export interface BaseEventMetadata {
325
+ /** App instance ID. */
326
+ instanceId?: string | null;
327
+ /** Event type. */
328
+ eventType?: string;
329
+ /** The identification type and identity data. */
330
+ identity?: IdentificationData;
331
+ }
332
+ export interface EventMetadata extends BaseEventMetadata {
333
+ /**
334
+ * Unique event ID.
335
+ * Allows clients to ignore duplicate webhooks.
336
+ */
337
+ _id?: string;
338
+ /**
339
+ * Assumes actions are also always typed to an entity_type
340
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
341
+ */
342
+ entityFqdn?: string;
343
+ /**
344
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
345
+ * This is although the created/updated/deleted notion is duplication of the oneof types
346
+ * Example: created/updated/deleted/started/completed/email_opened
347
+ */
348
+ slug?: string;
349
+ /** ID of the entity associated with the event. */
350
+ entityId?: string;
351
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
352
+ eventTime?: Date | null;
353
+ /**
354
+ * Whether the event was triggered as a result of a privacy regulation application
355
+ * (for example, GDPR).
356
+ */
357
+ triggeredByAnonymizeRequest?: boolean | null;
358
+ /** If present, indicates the action that triggered the event. */
359
+ originatedFrom?: string | null;
360
+ /**
361
+ * A sequence number defining the order of updates to the underlying entity.
362
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
363
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
364
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
365
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
366
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
367
+ */
368
+ entityEventSequence?: string | null;
369
+ }
370
+ export interface MemberReportCreatedEnvelope {
371
+ entity: MemberReport;
372
+ metadata: EventMetadata;
373
+ }
374
+ /**
375
+ * Triggered when a member is reported.
376
+ * @permissionScope Manage Members
377
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
378
+ * @permissionId MEMBERS.REPORTS_READ
379
+ * @webhook
380
+ * @eventType wix.members.v1.member_report_created
381
+ * @documentationMaturity preview
382
+ */
383
+ export declare function onMemberReportCreated(handler: (event: MemberReportCreatedEnvelope) => void | Promise<void>): void;
384
+ export interface MemberReportDeletedEnvelope {
385
+ metadata: EventMetadata;
386
+ }
387
+ /**
388
+ * Triggered when a report is deleted.
389
+ * @permissionScope Manage Members
390
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
391
+ * @permissionId MEMBERS.REPORTS_READ
392
+ * @webhook
393
+ * @eventType wix.members.v1.member_report_deleted
394
+ * @documentationMaturity preview
395
+ */
396
+ export declare function onMemberReportDeleted(handler: (event: MemberReportDeletedEnvelope) => void | Promise<void>): void;
397
+ export interface MemberReportReportedMemberCreatedEnvelope {
398
+ data: ReportedMemberCreated;
399
+ metadata: EventMetadata;
400
+ }
401
+ /** @permissionScope Manage Members
402
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
403
+ * @permissionId MEMBERS.REPORTS_READ
404
+ * @webhook
405
+ * @eventType wix.members.v1.member_report_reported_member_created
406
+ * @documentationMaturity preview
407
+ */
408
+ export declare function onMemberReportReportedMemberCreated(handler: (event: MemberReportReportedMemberCreatedEnvelope) => void | Promise<void>): void;
409
+ export interface MemberReportReportedMemberDeletedEnvelope {
410
+ data: ReportedMemberDeleted;
411
+ metadata: EventMetadata;
412
+ }
413
+ /** @permissionScope Manage Members
414
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
415
+ * @permissionId MEMBERS.REPORTS_READ
416
+ * @webhook
417
+ * @eventType wix.members.v1.member_report_reported_member_deleted
418
+ * @documentationMaturity preview
419
+ */
420
+ export declare function onMemberReportReportedMemberDeleted(handler: (event: MemberReportReportedMemberDeletedEnvelope) => void | Promise<void>): void;
421
+ /**
422
+ * Creates a report for the reported member.
423
+ * @param memberReport - Details of a member to report.
424
+ * @public
425
+ * @documentationMaturity preview
426
+ * @requiredField memberReport
427
+ * @requiredField memberReport.reason
428
+ * @requiredField memberReport.reportedMemberId
429
+ * @permissionId MEMBERS.REPORTS_WRITE
430
+ * @applicableIdentity MEMBER
431
+ * @fqn com.wixpress.members.memberreports.MemberReports.ReportMember
432
+ */
433
+ export declare function reportMember(memberReport: MemberReport): Promise<ReportMemberResponse & ReportMemberResponseNonNullableFields>;
434
+ /**
435
+ * Creates a query to retrieve a list of events.
436
+ *
437
+ * The `queryMemberReports()` function builds a query to retrieve a list of member reports and returns a `MemberReportsQueryBuilder` object.
438
+ *
439
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
440
+ *
441
+ * You can refine the query by chaining `MemberReportsQueryBuilder` functions onto the query. `MemberReportsQueryBuilder` functions enable you to sort, filter, and control the results `queryMemberReports()` returns.
442
+ *
443
+ * `queryMemberReports()` runs with these `MemberReportsQueryBuilder` defaults, which you can override:
444
+ *
445
+ * - limit(50)
446
+ *
447
+ * The functions 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.
448
+ * @public
449
+ * @documentationMaturity preview
450
+ * @permissionScope Manage Members
451
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
452
+ * @permissionId MEMBERS.REPORTS_READ
453
+ * @applicableIdentity APP
454
+ * @fqn com.wixpress.members.memberreports.MemberReports.QueryMemberReports
455
+ */
456
+ export declare function queryMemberReports(): MemberReportsQueryBuilder;
457
+ interface QueryCursorResult {
458
+ cursors: Cursors;
459
+ hasNext: () => boolean;
460
+ hasPrev: () => boolean;
461
+ length: number;
462
+ pageSize: number;
463
+ }
464
+ export interface MemberReportsQueryResult extends QueryCursorResult {
465
+ items: MemberReport[];
466
+ query: MemberReportsQueryBuilder;
467
+ next: () => Promise<MemberReportsQueryResult>;
468
+ prev: () => Promise<MemberReportsQueryResult>;
469
+ }
470
+ export interface MemberReportsQueryBuilder {
471
+ /** @param propertyName - Property whose value is compared with `value`.
472
+ * @param value - Value to compare against.
473
+ * @documentationMaturity preview
474
+ */
475
+ eq: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId' | 'reason' | '_createdDate', value: any) => MemberReportsQueryBuilder;
476
+ /** @param propertyName - Property whose value is compared with `value`.
477
+ * @param value - Value to compare against.
478
+ * @documentationMaturity preview
479
+ */
480
+ ne: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId' | 'reason' | '_createdDate', value: any) => MemberReportsQueryBuilder;
481
+ /** @param propertyName - Property whose value is compared with `value`.
482
+ * @param value - Value to compare against.
483
+ * @documentationMaturity preview
484
+ */
485
+ ge: (propertyName: '_createdDate', value: any) => MemberReportsQueryBuilder;
486
+ /** @param propertyName - Property whose value is compared with `value`.
487
+ * @param value - Value to compare against.
488
+ * @documentationMaturity preview
489
+ */
490
+ gt: (propertyName: '_createdDate', value: any) => MemberReportsQueryBuilder;
491
+ /** @param propertyName - Property whose value is compared with `value`.
492
+ * @param value - Value to compare against.
493
+ * @documentationMaturity preview
494
+ */
495
+ le: (propertyName: '_createdDate', value: any) => MemberReportsQueryBuilder;
496
+ /** @param propertyName - Property whose value is compared with `value`.
497
+ * @param value - Value to compare against.
498
+ * @documentationMaturity preview
499
+ */
500
+ lt: (propertyName: '_createdDate', value: any) => MemberReportsQueryBuilder;
501
+ /** @param propertyName - Property whose value is compared with `string`.
502
+ * @param string - String to compare against. Case-insensitive.
503
+ * @documentationMaturity preview
504
+ */
505
+ startsWith: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId', value: string) => MemberReportsQueryBuilder;
506
+ /** @param propertyName - Property whose value is compared with `values`.
507
+ * @param values - List of values to compare against.
508
+ * @documentationMaturity preview
509
+ */
510
+ hasSome: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId' | 'reason' | '_createdDate', value: any[]) => MemberReportsQueryBuilder;
511
+ /** @documentationMaturity preview */
512
+ in: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId' | 'reason' | '_createdDate', value: any) => MemberReportsQueryBuilder;
513
+ /** @documentationMaturity preview */
514
+ exists: (propertyName: '_id' | 'reportedMemberId' | 'reportingMemberId' | 'reason' | '_createdDate', value: boolean) => MemberReportsQueryBuilder;
515
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
516
+ * @documentationMaturity preview
517
+ */
518
+ limit: (limit: number) => MemberReportsQueryBuilder;
519
+ /** @param cursor - A pointer to specific record
520
+ * @documentationMaturity preview
521
+ */
522
+ skipTo: (cursor: string) => MemberReportsQueryBuilder;
523
+ /** @documentationMaturity preview */
524
+ find: () => Promise<MemberReportsQueryResult>;
525
+ }
526
+ /**
527
+ * Retrieves a list of reported members.
528
+ * @public
529
+ * @documentationMaturity preview
530
+ * @permissionId MEMBERS.REPORTS_READ
531
+ * @permissionScope Manage Members
532
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
533
+ * @applicableIdentity APP
534
+ * @fqn com.wixpress.members.memberreports.MemberReports.ListReportedMembers
535
+ * @deprecated
536
+ * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
537
+ * @targetRemovalDate 2025-01-31
538
+ */
539
+ export declare function listReportedMembers(options?: ListReportedMembersOptions): Promise<ListReportedMembersResponse & ListReportedMembersResponseNonNullableFields>;
540
+ export interface ListReportedMembersOptions extends ListReportedMembersRequestPagingMethodOneOf {
541
+ /** 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`. */
542
+ cursorPaging?: CursorPaging;
543
+ }
544
+ /**
545
+ * Retrieves a list of reported members, given the provided paging, filtering, and sorting.
546
+ *
547
+ * Query Reported Members runs with these defaults, which you can override:
548
+ * - `createdDate` is sorted in `ASC` order
549
+ * - `paging.limit` is `100`
550
+ * - `paging.offset` is `0`
551
+ *
552
+ * For field support for filters and sorting, see [Supported Filters and Sorting]().
553
+ * 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).
554
+ * @public
555
+ * @documentationMaturity preview
556
+ * @permissionId MEMBERS.REPORTS_READ
557
+ * @permissionScope Manage Members
558
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
559
+ * @applicableIdentity APP
560
+ * @fqn com.wixpress.members.memberreports.MemberReports.QueryReportedMembers
561
+ * @deprecated
562
+ * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews
563
+ * @targetRemovalDate 2025-01-31
564
+ */
565
+ export declare function queryReportedMembers(options?: QueryReportedMembersOptions): Promise<QueryReportedMembersResponse & QueryReportedMembersResponseNonNullableFields>;
566
+ export interface QueryReportedMembersOptions {
567
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
568
+ query?: QueryV2;
569
+ }
570
+ /**
571
+ * Deletes all reports of a member.
572
+ * @param memberId - ID of the member whose reports to be deleted.
573
+ * @public
574
+ * @documentationMaturity preview
575
+ * @requiredField memberId
576
+ * @permissionId MEMBERS.REPORTS_DELETE
577
+ * @permissionScope Manage Members
578
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
579
+ * @applicableIdentity APP
580
+ * @fqn com.wixpress.members.memberreports.MemberReports.DeleteMemberReports
581
+ */
582
+ export declare function deleteMemberReports(memberId: string): Promise<void>;
583
+ export {};