@wix/auto_sdk_members_member-report 1.0.14 → 1.0.16

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