@wix/reports 1.0.4 → 1.0.6
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/es/package.json +3 -0
- package/meta/package.json +1 -5
- package/package.json +19 -16
- package/build/cjs/context.d.ts +0 -1
- package/build/cjs/context.js +0 -28
- package/build/cjs/context.js.map +0 -1
- package/build/es/context.d.ts +0 -1
- package/build/es/context.js +0 -2
- package/build/es/context.js.map +0 -1
- package/context/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -1355
- package/type-bundles/index.bundle.d.ts +0 -1355
- package/type-bundles/meta.bundle.d.ts +0 -636
|
@@ -1,636 +0,0 @@
|
|
|
1
|
-
interface Report$1 {
|
|
2
|
-
/**
|
|
3
|
-
* Report ID.
|
|
4
|
-
* @readonly
|
|
5
|
-
*/
|
|
6
|
-
id?: string | null;
|
|
7
|
-
/** Reported entity name, such as `comment`. */
|
|
8
|
-
entityName?: string;
|
|
9
|
-
/** Reported entity ID. */
|
|
10
|
-
entityId?: string;
|
|
11
|
-
/**
|
|
12
|
-
* Identity of who created a report.
|
|
13
|
-
* @readonly
|
|
14
|
-
*/
|
|
15
|
-
identity?: CommonIdentificationData$1;
|
|
16
|
-
/** Reason for the report. */
|
|
17
|
-
reason?: Reason$1;
|
|
18
|
-
/**
|
|
19
|
-
* Revision number, which increments by 1 each time the rule is updated. To prevent conflicting changes, the existing revision must be used when updating a rule.
|
|
20
|
-
* @readonly
|
|
21
|
-
*/
|
|
22
|
-
revision?: string | null;
|
|
23
|
-
/**
|
|
24
|
-
* Date and time when the report created.
|
|
25
|
-
* @readonly
|
|
26
|
-
*/
|
|
27
|
-
createdDate?: Date | null;
|
|
28
|
-
/**
|
|
29
|
-
* Date and time when the report updated.
|
|
30
|
-
* @readonly
|
|
31
|
-
*/
|
|
32
|
-
updatedDate?: Date | null;
|
|
33
|
-
/**
|
|
34
|
-
* Custom field data for the report object.
|
|
35
|
-
*
|
|
36
|
-
* **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
|
|
37
|
-
*/
|
|
38
|
-
extendedFields?: ExtendedFields$1;
|
|
39
|
-
}
|
|
40
|
-
interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
|
|
41
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
42
|
-
anonymousVisitorId?: string;
|
|
43
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
44
|
-
memberId?: string;
|
|
45
|
-
/**
|
|
46
|
-
* Identity type
|
|
47
|
-
* @readonly
|
|
48
|
-
*/
|
|
49
|
-
identityType?: IdentityType$1;
|
|
50
|
-
}
|
|
51
|
-
/** @oneof */
|
|
52
|
-
interface CommonIdentificationDataIdOneOf$1 {
|
|
53
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
54
|
-
anonymousVisitorId?: string;
|
|
55
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
56
|
-
memberId?: string;
|
|
57
|
-
}
|
|
58
|
-
declare enum IdentityType$1 {
|
|
59
|
-
/** Unknown type. This value is not used. */
|
|
60
|
-
UNKNOWN = "UNKNOWN",
|
|
61
|
-
/** A site visitor who has not logged in. */
|
|
62
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
63
|
-
/** A logged-in site member. */
|
|
64
|
-
MEMBER = "MEMBER",
|
|
65
|
-
/** A Wix account holder, such as a site owner or contributor. This value is not used. */
|
|
66
|
-
WIX_USER = "WIX_USER",
|
|
67
|
-
/** An application integrated with the Wix platform. This value is not used. */
|
|
68
|
-
APP = "APP"
|
|
69
|
-
}
|
|
70
|
-
interface Reason$1 {
|
|
71
|
-
/** Report reason type. */
|
|
72
|
-
reasonType?: Type$1;
|
|
73
|
-
/** Why the entity is reported. */
|
|
74
|
-
details?: string | null;
|
|
75
|
-
}
|
|
76
|
-
declare enum Type$1 {
|
|
77
|
-
/** Unknown type. This value is not used. */
|
|
78
|
-
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
79
|
-
/** Entity is reported for other reasons. Specify in `details`. */
|
|
80
|
-
OTHER = "OTHER",
|
|
81
|
-
/** Entity is reported for spam. */
|
|
82
|
-
SPAM = "SPAM",
|
|
83
|
-
/** Entity is reported for nudity or sexual harassment. */
|
|
84
|
-
NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
|
|
85
|
-
/** Entity is reported for hate speech. */
|
|
86
|
-
HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
|
|
87
|
-
/** Entity is reported for false information. */
|
|
88
|
-
FALSE_INFORMATION = "FALSE_INFORMATION",
|
|
89
|
-
/** Entity is reported for a community guideline violation. */
|
|
90
|
-
COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
|
|
91
|
-
/** Entity is reported for violence. */
|
|
92
|
-
VIOLENCE = "VIOLENCE",
|
|
93
|
-
/** Entity is reported for mentioning suicide. */
|
|
94
|
-
SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
|
|
95
|
-
/** Entity is reported for unuathorized sales. */
|
|
96
|
-
UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
|
|
97
|
-
/** Entity is reported for mentioning an eating disorder. */
|
|
98
|
-
EATING_DISORDER = "EATING_DISORDER",
|
|
99
|
-
/** Entity is reported for involving a minor. */
|
|
100
|
-
INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
|
|
101
|
-
/** Entity is reported for mentioning terrorism. */
|
|
102
|
-
TERRORISM = "TERRORISM",
|
|
103
|
-
/** Entity is reported for mentioning drugs. */
|
|
104
|
-
DRUGS = "DRUGS",
|
|
105
|
-
/** Entity is reported for unlawful actions. */
|
|
106
|
-
UNLAWFUL = "UNLAWFUL",
|
|
107
|
-
/** Entity is reported for exposing identifying details. */
|
|
108
|
-
EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
|
|
109
|
-
}
|
|
110
|
-
interface ExtendedFields$1 {
|
|
111
|
-
/**
|
|
112
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
113
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
114
|
-
*
|
|
115
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
116
|
-
*
|
|
117
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
118
|
-
*/
|
|
119
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
120
|
-
}
|
|
121
|
-
interface CreateReportRequest$1 {
|
|
122
|
-
/** Report details. */
|
|
123
|
-
report: Report$1;
|
|
124
|
-
}
|
|
125
|
-
interface CreateReportResponse$1 {
|
|
126
|
-
/** Created report. */
|
|
127
|
-
report?: Report$1;
|
|
128
|
-
}
|
|
129
|
-
interface GetReportRequest$1 {
|
|
130
|
-
/** ID of the report to retrieve. */
|
|
131
|
-
reportId: string;
|
|
132
|
-
}
|
|
133
|
-
interface GetReportResponse$1 {
|
|
134
|
-
/** Retrieved report. */
|
|
135
|
-
report?: Report$1;
|
|
136
|
-
}
|
|
137
|
-
interface UpdateReportRequest$1 {
|
|
138
|
-
/** Report to update. */
|
|
139
|
-
report: Report$1;
|
|
140
|
-
}
|
|
141
|
-
interface UpdateReportResponse$1 {
|
|
142
|
-
/** Updated report. */
|
|
143
|
-
report?: Report$1;
|
|
144
|
-
}
|
|
145
|
-
interface DeleteReportRequest$1 {
|
|
146
|
-
/** ID of the report to delete. */
|
|
147
|
-
reportId: string;
|
|
148
|
-
}
|
|
149
|
-
interface DeleteReportResponse$1 {
|
|
150
|
-
}
|
|
151
|
-
interface UpsertReportRequest$1 {
|
|
152
|
-
/** Report to create or update. */
|
|
153
|
-
report?: Report$1;
|
|
154
|
-
}
|
|
155
|
-
interface UpsertReportResponse$1 {
|
|
156
|
-
/** Updated or created report. */
|
|
157
|
-
report?: Report$1;
|
|
158
|
-
}
|
|
159
|
-
interface BulkDeleteReportsByFilterRequest$1 {
|
|
160
|
-
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
161
|
-
filter: Record<string, any> | null;
|
|
162
|
-
}
|
|
163
|
-
interface BulkDeleteReportsByFilterResponse$1 {
|
|
164
|
-
/** Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */
|
|
165
|
-
jobId?: string;
|
|
166
|
-
}
|
|
167
|
-
interface CountReportsByReasonTypesRequest$1 {
|
|
168
|
-
/** Reported entity name. For example, `comment`. */
|
|
169
|
-
entityName: string;
|
|
170
|
-
/** ID of the reported entity. */
|
|
171
|
-
entityId: string;
|
|
172
|
-
}
|
|
173
|
-
interface CountReportsByReasonTypesResponse$1 {
|
|
174
|
-
/** List of reports grouped by the reason type. */
|
|
175
|
-
reasonTypeCount?: ReasonTypeCount$1[];
|
|
176
|
-
}
|
|
177
|
-
interface ReasonTypeCount$1 {
|
|
178
|
-
/** Reason for report. */
|
|
179
|
-
reasonType?: Type$1;
|
|
180
|
-
/** Number of reports by reason type. */
|
|
181
|
-
count?: number;
|
|
182
|
-
}
|
|
183
|
-
interface QueryReportsRequest$1 {
|
|
184
|
-
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
185
|
-
query?: CursorQuery$1;
|
|
186
|
-
}
|
|
187
|
-
interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
|
|
188
|
-
/** Cursor paging options */
|
|
189
|
-
cursorPaging?: CursorPaging$1;
|
|
190
|
-
/** Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information. */
|
|
191
|
-
filter?: Record<string, any> | null;
|
|
192
|
-
/** Sorting options */
|
|
193
|
-
sort?: Sorting$1[];
|
|
194
|
-
}
|
|
195
|
-
/** @oneof */
|
|
196
|
-
interface CursorQueryPagingMethodOneOf$1 {
|
|
197
|
-
/** Cursor paging options */
|
|
198
|
-
cursorPaging?: CursorPaging$1;
|
|
199
|
-
}
|
|
200
|
-
interface Sorting$1 {
|
|
201
|
-
/** Name of the field to sort by. */
|
|
202
|
-
fieldName?: string;
|
|
203
|
-
/** Sort order. */
|
|
204
|
-
order?: SortOrder$1;
|
|
205
|
-
}
|
|
206
|
-
declare enum SortOrder$1 {
|
|
207
|
-
ASC = "ASC",
|
|
208
|
-
DESC = "DESC"
|
|
209
|
-
}
|
|
210
|
-
interface CursorPaging$1 {
|
|
211
|
-
/** Maximum number of items to return in the results. */
|
|
212
|
-
limit?: number | null;
|
|
213
|
-
/**
|
|
214
|
-
* Pointer to the next or previous page in the list of results.
|
|
215
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
216
|
-
*/
|
|
217
|
-
cursor?: string | null;
|
|
218
|
-
}
|
|
219
|
-
interface QueryReportsResponse$1 {
|
|
220
|
-
/** List of reports. */
|
|
221
|
-
reports?: Report$1[];
|
|
222
|
-
/** Paging metadata. */
|
|
223
|
-
pagingMetadata?: CursorPagingMetadata$1;
|
|
224
|
-
}
|
|
225
|
-
interface CursorPagingMetadata$1 {
|
|
226
|
-
/** Number of items returned in the response. */
|
|
227
|
-
count?: number | null;
|
|
228
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
229
|
-
cursors?: Cursors$1;
|
|
230
|
-
/** Whether there are more pages to retrieve following the current page. */
|
|
231
|
-
hasNext?: boolean | null;
|
|
232
|
-
}
|
|
233
|
-
interface Cursors$1 {
|
|
234
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
235
|
-
next?: string | null;
|
|
236
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
237
|
-
prev?: string | null;
|
|
238
|
-
}
|
|
239
|
-
interface UpdateExtendedFieldsRequest$1 {
|
|
240
|
-
/** ID of the report to update. */
|
|
241
|
-
id: string;
|
|
242
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
243
|
-
namespace: string;
|
|
244
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
245
|
-
namespaceData: Record<string, any> | null;
|
|
246
|
-
}
|
|
247
|
-
interface UpdateExtendedFieldsResponse$1 {
|
|
248
|
-
/** Updated report. */
|
|
249
|
-
report?: Report$1;
|
|
250
|
-
}
|
|
251
|
-
interface CommonIdentificationDataNonNullableFields$1 {
|
|
252
|
-
anonymousVisitorId: string;
|
|
253
|
-
memberId: string;
|
|
254
|
-
wixUserId: string;
|
|
255
|
-
appId: string;
|
|
256
|
-
identityType: IdentityType$1;
|
|
257
|
-
}
|
|
258
|
-
interface ReasonNonNullableFields$1 {
|
|
259
|
-
reasonType: Type$1;
|
|
260
|
-
}
|
|
261
|
-
interface ReportNonNullableFields$1 {
|
|
262
|
-
entityName: string;
|
|
263
|
-
entityId: string;
|
|
264
|
-
identity?: CommonIdentificationDataNonNullableFields$1;
|
|
265
|
-
reason?: ReasonNonNullableFields$1;
|
|
266
|
-
}
|
|
267
|
-
interface CreateReportResponseNonNullableFields$1 {
|
|
268
|
-
report?: ReportNonNullableFields$1;
|
|
269
|
-
}
|
|
270
|
-
interface GetReportResponseNonNullableFields$1 {
|
|
271
|
-
report?: ReportNonNullableFields$1;
|
|
272
|
-
}
|
|
273
|
-
interface UpdateReportResponseNonNullableFields$1 {
|
|
274
|
-
report?: ReportNonNullableFields$1;
|
|
275
|
-
}
|
|
276
|
-
interface UpsertReportResponseNonNullableFields$1 {
|
|
277
|
-
report?: ReportNonNullableFields$1;
|
|
278
|
-
}
|
|
279
|
-
interface BulkDeleteReportsByFilterResponseNonNullableFields$1 {
|
|
280
|
-
jobId: string;
|
|
281
|
-
}
|
|
282
|
-
interface ReasonTypeCountNonNullableFields$1 {
|
|
283
|
-
reasonType: Type$1;
|
|
284
|
-
count: number;
|
|
285
|
-
}
|
|
286
|
-
interface CountReportsByReasonTypesResponseNonNullableFields$1 {
|
|
287
|
-
reasonTypeCount: ReasonTypeCountNonNullableFields$1[];
|
|
288
|
-
}
|
|
289
|
-
interface QueryReportsResponseNonNullableFields$1 {
|
|
290
|
-
reports: ReportNonNullableFields$1[];
|
|
291
|
-
}
|
|
292
|
-
interface UpdateExtendedFieldsResponseNonNullableFields$1 {
|
|
293
|
-
report?: ReportNonNullableFields$1;
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
interface Report {
|
|
297
|
-
/**
|
|
298
|
-
* Report ID.
|
|
299
|
-
* @readonly
|
|
300
|
-
*/
|
|
301
|
-
_id?: string | null;
|
|
302
|
-
/** Reported entity name, such as `comment`. */
|
|
303
|
-
entityName?: string;
|
|
304
|
-
/** Reported entity ID. */
|
|
305
|
-
entityId?: string;
|
|
306
|
-
/**
|
|
307
|
-
* Identity of who created a report.
|
|
308
|
-
* @readonly
|
|
309
|
-
*/
|
|
310
|
-
identity?: CommonIdentificationData;
|
|
311
|
-
/** Reason for the report. */
|
|
312
|
-
reason?: Reason;
|
|
313
|
-
/**
|
|
314
|
-
* Revision number, which increments by 1 each time the rule is updated. To prevent conflicting changes, the existing revision must be used when updating a rule.
|
|
315
|
-
* @readonly
|
|
316
|
-
*/
|
|
317
|
-
revision?: string | null;
|
|
318
|
-
/**
|
|
319
|
-
* Date and time when the report created.
|
|
320
|
-
* @readonly
|
|
321
|
-
*/
|
|
322
|
-
_createdDate?: Date | null;
|
|
323
|
-
/**
|
|
324
|
-
* Date and time when the report updated.
|
|
325
|
-
* @readonly
|
|
326
|
-
*/
|
|
327
|
-
_updatedDate?: Date | null;
|
|
328
|
-
/**
|
|
329
|
-
* Custom field data for the report object.
|
|
330
|
-
*
|
|
331
|
-
* **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
|
|
332
|
-
*/
|
|
333
|
-
extendedFields?: ExtendedFields;
|
|
334
|
-
}
|
|
335
|
-
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
336
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
337
|
-
anonymousVisitorId?: string;
|
|
338
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
339
|
-
memberId?: string;
|
|
340
|
-
/**
|
|
341
|
-
* Identity type
|
|
342
|
-
* @readonly
|
|
343
|
-
*/
|
|
344
|
-
identityType?: IdentityType;
|
|
345
|
-
}
|
|
346
|
-
/** @oneof */
|
|
347
|
-
interface CommonIdentificationDataIdOneOf {
|
|
348
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
349
|
-
anonymousVisitorId?: string;
|
|
350
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
351
|
-
memberId?: string;
|
|
352
|
-
}
|
|
353
|
-
declare enum IdentityType {
|
|
354
|
-
/** Unknown type. This value is not used. */
|
|
355
|
-
UNKNOWN = "UNKNOWN",
|
|
356
|
-
/** A site visitor who has not logged in. */
|
|
357
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
358
|
-
/** A logged-in site member. */
|
|
359
|
-
MEMBER = "MEMBER",
|
|
360
|
-
/** A Wix account holder, such as a site owner or contributor. This value is not used. */
|
|
361
|
-
WIX_USER = "WIX_USER",
|
|
362
|
-
/** An application integrated with the Wix platform. This value is not used. */
|
|
363
|
-
APP = "APP"
|
|
364
|
-
}
|
|
365
|
-
interface Reason {
|
|
366
|
-
/** Report reason type. */
|
|
367
|
-
reasonType?: Type;
|
|
368
|
-
/** Why the entity is reported. */
|
|
369
|
-
details?: string | null;
|
|
370
|
-
}
|
|
371
|
-
declare enum Type {
|
|
372
|
-
/** Unknown type. This value is not used. */
|
|
373
|
-
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
374
|
-
/** Entity is reported for other reasons. Specify in `details`. */
|
|
375
|
-
OTHER = "OTHER",
|
|
376
|
-
/** Entity is reported for spam. */
|
|
377
|
-
SPAM = "SPAM",
|
|
378
|
-
/** Entity is reported for nudity or sexual harassment. */
|
|
379
|
-
NUDITY_OR_SEXUAL_HARASSMENT = "NUDITY_OR_SEXUAL_HARASSMENT",
|
|
380
|
-
/** Entity is reported for hate speech. */
|
|
381
|
-
HATE_SPEECH_OR_SYMBOLS = "HATE_SPEECH_OR_SYMBOLS",
|
|
382
|
-
/** Entity is reported for false information. */
|
|
383
|
-
FALSE_INFORMATION = "FALSE_INFORMATION",
|
|
384
|
-
/** Entity is reported for a community guideline violation. */
|
|
385
|
-
COMMUNITY_GUIDELINES_VIOLATION = "COMMUNITY_GUIDELINES_VIOLATION",
|
|
386
|
-
/** Entity is reported for violence. */
|
|
387
|
-
VIOLENCE = "VIOLENCE",
|
|
388
|
-
/** Entity is reported for mentioning suicide. */
|
|
389
|
-
SUICIDE_OR_SELF_INJURY = "SUICIDE_OR_SELF_INJURY",
|
|
390
|
-
/** Entity is reported for unuathorized sales. */
|
|
391
|
-
UNAUTHORIZED_SALES = "UNAUTHORIZED_SALES",
|
|
392
|
-
/** Entity is reported for mentioning an eating disorder. */
|
|
393
|
-
EATING_DISORDER = "EATING_DISORDER",
|
|
394
|
-
/** Entity is reported for involving a minor. */
|
|
395
|
-
INVOLVES_A_CHILD = "INVOLVES_A_CHILD",
|
|
396
|
-
/** Entity is reported for mentioning terrorism. */
|
|
397
|
-
TERRORISM = "TERRORISM",
|
|
398
|
-
/** Entity is reported for mentioning drugs. */
|
|
399
|
-
DRUGS = "DRUGS",
|
|
400
|
-
/** Entity is reported for unlawful actions. */
|
|
401
|
-
UNLAWFUL = "UNLAWFUL",
|
|
402
|
-
/** Entity is reported for exposing identifying details. */
|
|
403
|
-
EXPOSING_IDENTIFYING_INFO = "EXPOSING_IDENTIFYING_INFO"
|
|
404
|
-
}
|
|
405
|
-
interface ExtendedFields {
|
|
406
|
-
/**
|
|
407
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
408
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
409
|
-
*
|
|
410
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
411
|
-
*
|
|
412
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
413
|
-
*/
|
|
414
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
415
|
-
}
|
|
416
|
-
interface CreateReportRequest {
|
|
417
|
-
/** Report details. */
|
|
418
|
-
report: Report;
|
|
419
|
-
}
|
|
420
|
-
interface CreateReportResponse {
|
|
421
|
-
/** Created report. */
|
|
422
|
-
report?: Report;
|
|
423
|
-
}
|
|
424
|
-
interface GetReportRequest {
|
|
425
|
-
/** ID of the report to retrieve. */
|
|
426
|
-
reportId: string;
|
|
427
|
-
}
|
|
428
|
-
interface GetReportResponse {
|
|
429
|
-
/** Retrieved report. */
|
|
430
|
-
report?: Report;
|
|
431
|
-
}
|
|
432
|
-
interface UpdateReportRequest {
|
|
433
|
-
/** Report to update. */
|
|
434
|
-
report: Report;
|
|
435
|
-
}
|
|
436
|
-
interface UpdateReportResponse {
|
|
437
|
-
/** Updated report. */
|
|
438
|
-
report?: Report;
|
|
439
|
-
}
|
|
440
|
-
interface DeleteReportRequest {
|
|
441
|
-
/** ID of the report to delete. */
|
|
442
|
-
reportId: string;
|
|
443
|
-
}
|
|
444
|
-
interface DeleteReportResponse {
|
|
445
|
-
}
|
|
446
|
-
interface UpsertReportRequest {
|
|
447
|
-
/** Report to create or update. */
|
|
448
|
-
report?: Report;
|
|
449
|
-
}
|
|
450
|
-
interface UpsertReportResponse {
|
|
451
|
-
/** Updated or created report. */
|
|
452
|
-
report?: Report;
|
|
453
|
-
}
|
|
454
|
-
interface BulkDeleteReportsByFilterRequest {
|
|
455
|
-
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
456
|
-
filter: Record<string, any> | null;
|
|
457
|
-
}
|
|
458
|
-
interface BulkDeleteReportsByFilterResponse {
|
|
459
|
-
/** Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */
|
|
460
|
-
jobId?: string;
|
|
461
|
-
}
|
|
462
|
-
interface CountReportsByReasonTypesRequest {
|
|
463
|
-
/** Reported entity name. For example, `comment`. */
|
|
464
|
-
entityName: string;
|
|
465
|
-
/** ID of the reported entity. */
|
|
466
|
-
entityId: string;
|
|
467
|
-
}
|
|
468
|
-
interface CountReportsByReasonTypesResponse {
|
|
469
|
-
/** List of reports grouped by the reason type. */
|
|
470
|
-
reasonTypeCount?: ReasonTypeCount[];
|
|
471
|
-
}
|
|
472
|
-
interface ReasonTypeCount {
|
|
473
|
-
/** Reason for report. */
|
|
474
|
-
reasonType?: Type;
|
|
475
|
-
/** Number of reports by reason type. */
|
|
476
|
-
count?: number;
|
|
477
|
-
}
|
|
478
|
-
interface QueryReportsRequest {
|
|
479
|
-
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
480
|
-
query?: CursorQuery;
|
|
481
|
-
}
|
|
482
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
483
|
-
/** Cursor paging options */
|
|
484
|
-
cursorPaging?: CursorPaging;
|
|
485
|
-
/** Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information. */
|
|
486
|
-
filter?: Record<string, any> | null;
|
|
487
|
-
/** Sorting options */
|
|
488
|
-
sort?: Sorting[];
|
|
489
|
-
}
|
|
490
|
-
/** @oneof */
|
|
491
|
-
interface CursorQueryPagingMethodOneOf {
|
|
492
|
-
/** Cursor paging options */
|
|
493
|
-
cursorPaging?: CursorPaging;
|
|
494
|
-
}
|
|
495
|
-
interface Sorting {
|
|
496
|
-
/** Name of the field to sort by. */
|
|
497
|
-
fieldName?: string;
|
|
498
|
-
/** Sort order. */
|
|
499
|
-
order?: SortOrder;
|
|
500
|
-
}
|
|
501
|
-
declare enum SortOrder {
|
|
502
|
-
ASC = "ASC",
|
|
503
|
-
DESC = "DESC"
|
|
504
|
-
}
|
|
505
|
-
interface CursorPaging {
|
|
506
|
-
/** Maximum number of items to return in the results. */
|
|
507
|
-
limit?: number | null;
|
|
508
|
-
/**
|
|
509
|
-
* Pointer to the next or previous page in the list of results.
|
|
510
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
511
|
-
*/
|
|
512
|
-
cursor?: string | null;
|
|
513
|
-
}
|
|
514
|
-
interface QueryReportsResponse {
|
|
515
|
-
/** List of reports. */
|
|
516
|
-
reports?: Report[];
|
|
517
|
-
/** Paging metadata. */
|
|
518
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
519
|
-
}
|
|
520
|
-
interface CursorPagingMetadata {
|
|
521
|
-
/** Number of items returned in the response. */
|
|
522
|
-
count?: number | null;
|
|
523
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
524
|
-
cursors?: Cursors;
|
|
525
|
-
/** Whether there are more pages to retrieve following the current page. */
|
|
526
|
-
hasNext?: boolean | null;
|
|
527
|
-
}
|
|
528
|
-
interface Cursors {
|
|
529
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
530
|
-
next?: string | null;
|
|
531
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
532
|
-
prev?: string | null;
|
|
533
|
-
}
|
|
534
|
-
interface UpdateExtendedFieldsRequest {
|
|
535
|
-
/** ID of the report to update. */
|
|
536
|
-
_id: string;
|
|
537
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
538
|
-
namespace: string;
|
|
539
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
540
|
-
namespaceData: Record<string, any> | null;
|
|
541
|
-
}
|
|
542
|
-
interface UpdateExtendedFieldsResponse {
|
|
543
|
-
/** Updated report. */
|
|
544
|
-
report?: Report;
|
|
545
|
-
}
|
|
546
|
-
interface CommonIdentificationDataNonNullableFields {
|
|
547
|
-
anonymousVisitorId: string;
|
|
548
|
-
memberId: string;
|
|
549
|
-
wixUserId: string;
|
|
550
|
-
appId: string;
|
|
551
|
-
identityType: IdentityType;
|
|
552
|
-
}
|
|
553
|
-
interface ReasonNonNullableFields {
|
|
554
|
-
reasonType: Type;
|
|
555
|
-
}
|
|
556
|
-
interface ReportNonNullableFields {
|
|
557
|
-
entityName: string;
|
|
558
|
-
entityId: string;
|
|
559
|
-
identity?: CommonIdentificationDataNonNullableFields;
|
|
560
|
-
reason?: ReasonNonNullableFields;
|
|
561
|
-
}
|
|
562
|
-
interface CreateReportResponseNonNullableFields {
|
|
563
|
-
report?: ReportNonNullableFields;
|
|
564
|
-
}
|
|
565
|
-
interface GetReportResponseNonNullableFields {
|
|
566
|
-
report?: ReportNonNullableFields;
|
|
567
|
-
}
|
|
568
|
-
interface UpdateReportResponseNonNullableFields {
|
|
569
|
-
report?: ReportNonNullableFields;
|
|
570
|
-
}
|
|
571
|
-
interface UpsertReportResponseNonNullableFields {
|
|
572
|
-
report?: ReportNonNullableFields;
|
|
573
|
-
}
|
|
574
|
-
interface BulkDeleteReportsByFilterResponseNonNullableFields {
|
|
575
|
-
jobId: string;
|
|
576
|
-
}
|
|
577
|
-
interface ReasonTypeCountNonNullableFields {
|
|
578
|
-
reasonType: Type;
|
|
579
|
-
count: number;
|
|
580
|
-
}
|
|
581
|
-
interface CountReportsByReasonTypesResponseNonNullableFields {
|
|
582
|
-
reasonTypeCount: ReasonTypeCountNonNullableFields[];
|
|
583
|
-
}
|
|
584
|
-
interface QueryReportsResponseNonNullableFields {
|
|
585
|
-
reports: ReportNonNullableFields[];
|
|
586
|
-
}
|
|
587
|
-
interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
588
|
-
report?: ReportNonNullableFields;
|
|
589
|
-
}
|
|
590
|
-
|
|
591
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
592
|
-
getUrl: (context: any) => string;
|
|
593
|
-
httpMethod: K;
|
|
594
|
-
path: string;
|
|
595
|
-
pathParams: M;
|
|
596
|
-
__requestType: T;
|
|
597
|
-
__originalRequestType: S;
|
|
598
|
-
__responseType: Q;
|
|
599
|
-
__originalResponseType: R;
|
|
600
|
-
};
|
|
601
|
-
declare function createReport(): __PublicMethodMetaInfo<'POST', {}, CreateReportRequest, CreateReportRequest$1, CreateReportResponse & CreateReportResponseNonNullableFields, CreateReportResponse$1 & CreateReportResponseNonNullableFields$1>;
|
|
602
|
-
declare function getReport(): __PublicMethodMetaInfo<'GET', {
|
|
603
|
-
reportId: string;
|
|
604
|
-
}, GetReportRequest, GetReportRequest$1, GetReportResponse & GetReportResponseNonNullableFields, GetReportResponse$1 & GetReportResponseNonNullableFields$1>;
|
|
605
|
-
declare function updateReport(): __PublicMethodMetaInfo<'PATCH', {
|
|
606
|
-
reportId: string;
|
|
607
|
-
}, UpdateReportRequest, UpdateReportRequest$1, UpdateReportResponse & UpdateReportResponseNonNullableFields, UpdateReportResponse$1 & UpdateReportResponseNonNullableFields$1>;
|
|
608
|
-
declare function deleteReport(): __PublicMethodMetaInfo<'DELETE', {
|
|
609
|
-
reportId: string;
|
|
610
|
-
}, DeleteReportRequest, DeleteReportRequest$1, DeleteReportResponse, DeleteReportResponse$1>;
|
|
611
|
-
declare function upsertReport(): __PublicMethodMetaInfo<'POST', {
|
|
612
|
-
reportEntityName: string;
|
|
613
|
-
reportEntityId: string;
|
|
614
|
-
}, UpsertReportRequest, UpsertReportRequest$1, UpsertReportResponse & UpsertReportResponseNonNullableFields, UpsertReportResponse$1 & UpsertReportResponseNonNullableFields$1>;
|
|
615
|
-
declare function bulkDeleteReportsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteReportsByFilterRequest, BulkDeleteReportsByFilterRequest$1, BulkDeleteReportsByFilterResponse & BulkDeleteReportsByFilterResponseNonNullableFields, BulkDeleteReportsByFilterResponse$1 & BulkDeleteReportsByFilterResponseNonNullableFields$1>;
|
|
616
|
-
declare function countReportsByReasonTypes(): __PublicMethodMetaInfo<'POST', {}, CountReportsByReasonTypesRequest, CountReportsByReasonTypesRequest$1, CountReportsByReasonTypesResponse & CountReportsByReasonTypesResponseNonNullableFields, CountReportsByReasonTypesResponse$1 & CountReportsByReasonTypesResponseNonNullableFields$1>;
|
|
617
|
-
declare function queryReports(): __PublicMethodMetaInfo<'GET', {}, QueryReportsRequest, QueryReportsRequest$1, QueryReportsResponse & QueryReportsResponseNonNullableFields, QueryReportsResponse$1 & QueryReportsResponseNonNullableFields$1>;
|
|
618
|
-
declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
619
|
-
id: string;
|
|
620
|
-
}, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
|
|
621
|
-
|
|
622
|
-
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
623
|
-
declare const meta_bulkDeleteReportsByFilter: typeof bulkDeleteReportsByFilter;
|
|
624
|
-
declare const meta_countReportsByReasonTypes: typeof countReportsByReasonTypes;
|
|
625
|
-
declare const meta_createReport: typeof createReport;
|
|
626
|
-
declare const meta_deleteReport: typeof deleteReport;
|
|
627
|
-
declare const meta_getReport: typeof getReport;
|
|
628
|
-
declare const meta_queryReports: typeof queryReports;
|
|
629
|
-
declare const meta_updateExtendedFields: typeof updateExtendedFields;
|
|
630
|
-
declare const meta_updateReport: typeof updateReport;
|
|
631
|
-
declare const meta_upsertReport: typeof upsertReport;
|
|
632
|
-
declare namespace meta {
|
|
633
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkDeleteReportsByFilter as bulkDeleteReportsByFilter, meta_countReportsByReasonTypes as countReportsByReasonTypes, meta_createReport as createReport, meta_deleteReport as deleteReport, meta_getReport as getReport, meta_queryReports as queryReports, meta_updateExtendedFields as updateExtendedFields, meta_updateReport as updateReport, meta_upsertReport as upsertReport };
|
|
634
|
-
}
|
|
635
|
-
|
|
636
|
-
export { meta as reports };
|