@geowiki/evoland-api-proxy 0.15.0-dev.1
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/LICENSE +201 -0
- package/README.md +40 -0
- package/dist/index.d.mts +1104 -0
- package/dist/index.d.ts +1104 -0
- package/dist/index.js +1587 -0
- package/dist/index.mjs +1538 -0
- package/package.json +39 -0
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,1104 @@
|
|
|
1
|
+
type ApiRequestOptions = {
|
|
2
|
+
readonly method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH";
|
|
3
|
+
readonly url: string;
|
|
4
|
+
readonly path?: Record<string, any>;
|
|
5
|
+
readonly cookies?: Record<string, any>;
|
|
6
|
+
readonly headers?: Record<string, any>;
|
|
7
|
+
readonly query?: Record<string, any>;
|
|
8
|
+
readonly formData?: Record<string, any>;
|
|
9
|
+
readonly body?: any;
|
|
10
|
+
readonly mediaType?: string;
|
|
11
|
+
readonly responseHeader?: string;
|
|
12
|
+
readonly errors?: Record<number, string>;
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
type ApiResult = {
|
|
16
|
+
readonly url: string;
|
|
17
|
+
readonly ok: boolean;
|
|
18
|
+
readonly status: number;
|
|
19
|
+
readonly statusText: string;
|
|
20
|
+
readonly body: any;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
declare class ApiError extends Error {
|
|
24
|
+
readonly url: string;
|
|
25
|
+
readonly status: number;
|
|
26
|
+
readonly statusText: string;
|
|
27
|
+
readonly body: any;
|
|
28
|
+
readonly request: ApiRequestOptions;
|
|
29
|
+
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
declare class CancelError extends Error {
|
|
33
|
+
constructor(message: string);
|
|
34
|
+
get isCancelled(): boolean;
|
|
35
|
+
}
|
|
36
|
+
interface OnCancel {
|
|
37
|
+
readonly isResolved: boolean;
|
|
38
|
+
readonly isRejected: boolean;
|
|
39
|
+
readonly isCancelled: boolean;
|
|
40
|
+
(cancelHandler: () => void): void;
|
|
41
|
+
}
|
|
42
|
+
declare class CancelablePromise<T> implements Promise<T> {
|
|
43
|
+
#private;
|
|
44
|
+
constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
|
|
45
|
+
get [Symbol.toStringTag](): string;
|
|
46
|
+
then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
|
|
47
|
+
catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
|
|
48
|
+
finally(onFinally?: (() => void) | null): Promise<T>;
|
|
49
|
+
cancel(): void;
|
|
50
|
+
get isCancelled(): boolean;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
|
|
54
|
+
type Headers = Record<string, string>;
|
|
55
|
+
type OpenAPIConfig = {
|
|
56
|
+
BASE: string;
|
|
57
|
+
VERSION: string;
|
|
58
|
+
WITH_CREDENTIALS: boolean;
|
|
59
|
+
CREDENTIALS: "include" | "omit" | "same-origin";
|
|
60
|
+
TOKEN?: string | Resolver<string> | undefined;
|
|
61
|
+
USERNAME?: string | Resolver<string> | undefined;
|
|
62
|
+
PASSWORD?: string | Resolver<string> | undefined;
|
|
63
|
+
HEADERS?: Headers | Resolver<Headers> | undefined;
|
|
64
|
+
ENCODE_PATH?: ((path: string) => string) | undefined;
|
|
65
|
+
};
|
|
66
|
+
declare const OpenAPI: OpenAPIConfig;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Response for the home route, returning the version number of the API.
|
|
70
|
+
*/
|
|
71
|
+
type AboutResponse = {
|
|
72
|
+
info: string;
|
|
73
|
+
version: string;
|
|
74
|
+
};
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Request for the active learning route
|
|
78
|
+
*/
|
|
79
|
+
type ActiveLearningRequest = {
|
|
80
|
+
location_id: string;
|
|
81
|
+
project_id: number;
|
|
82
|
+
reference_date: string;
|
|
83
|
+
base64_array: string;
|
|
84
|
+
array_width: number;
|
|
85
|
+
array_height: number;
|
|
86
|
+
};
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Response for the active learning route
|
|
90
|
+
*/
|
|
91
|
+
type ActiveLearningResponse = {
|
|
92
|
+
success: boolean;
|
|
93
|
+
href: (string | null);
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
type AnnotationRequest = {
|
|
97
|
+
is_annual_annotation: boolean;
|
|
98
|
+
project_id: number;
|
|
99
|
+
item_buffer: string;
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
type Answer = {
|
|
103
|
+
id: number;
|
|
104
|
+
text: string;
|
|
105
|
+
order_id: number;
|
|
106
|
+
question_id: number;
|
|
107
|
+
child_question_id?: (number | null);
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
type AssetElement = {
|
|
111
|
+
id: number;
|
|
112
|
+
type: string;
|
|
113
|
+
name: string;
|
|
114
|
+
creation_date: string;
|
|
115
|
+
href: string;
|
|
116
|
+
reference_date: string;
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
type Body_bulk_upload_locations_uploadlocations__post = {
|
|
120
|
+
file: Blob;
|
|
121
|
+
project_id: number;
|
|
122
|
+
group_id: number;
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
type Body_bulk_upload_review_tasks_uploadreviewtasks_post = {
|
|
126
|
+
file: Blob;
|
|
127
|
+
project_id: number;
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
type Body_upload_location_task_uploadlocationtask__post = {
|
|
131
|
+
file: Blob;
|
|
132
|
+
project_id: number;
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Request to create a location to a given project.
|
|
137
|
+
*/
|
|
138
|
+
type CreateLocationRequest = {
|
|
139
|
+
project_id: number;
|
|
140
|
+
lat: number;
|
|
141
|
+
lon: number;
|
|
142
|
+
width: number;
|
|
143
|
+
height: number;
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
type CreateProjectRequest = {
|
|
147
|
+
project_name: string;
|
|
148
|
+
project_type: string;
|
|
149
|
+
mixed_labels_level: number;
|
|
150
|
+
current_group: string;
|
|
151
|
+
};
|
|
152
|
+
|
|
153
|
+
type CreateProjectResponse = {
|
|
154
|
+
project_id: number;
|
|
155
|
+
project_name: string;
|
|
156
|
+
};
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Request sent for creating a task for a specific user on a specific
|
|
160
|
+
* location
|
|
161
|
+
*/
|
|
162
|
+
type CreateTaskRequest = {
|
|
163
|
+
location_id: string;
|
|
164
|
+
project_id: number;
|
|
165
|
+
reference_date: string;
|
|
166
|
+
meta_data?: (Record<string, any> | null);
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
type CreateUserRequest = {
|
|
170
|
+
user_id: string;
|
|
171
|
+
user_alias: string;
|
|
172
|
+
};
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Request to delete a task from the database
|
|
176
|
+
*/
|
|
177
|
+
type DeleteTaskRequest = {
|
|
178
|
+
project_id: number;
|
|
179
|
+
task_id: number;
|
|
180
|
+
};
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Generic response when an action is requested by the user to the API
|
|
184
|
+
* but the call doesn't return any data.
|
|
185
|
+
*/
|
|
186
|
+
type GenericResponse = {
|
|
187
|
+
success: boolean;
|
|
188
|
+
message: (string | null);
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Request sent for getting the assets of a location given asset type,
|
|
193
|
+
* location_id, project_id and reference date. Optionally user can send a
|
|
194
|
+
* substring of the asset name to filter the assets.
|
|
195
|
+
*/
|
|
196
|
+
type GetAssetsRequest = {
|
|
197
|
+
location_id: string;
|
|
198
|
+
project_id: number;
|
|
199
|
+
reference_date: (string | null);
|
|
200
|
+
asset_type: string;
|
|
201
|
+
task_id: (number | null);
|
|
202
|
+
name_filter?: (string | null);
|
|
203
|
+
};
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Request sent for getting the polygon information of a particolar
|
|
207
|
+
* location
|
|
208
|
+
*/
|
|
209
|
+
type GetLocationRequest = {
|
|
210
|
+
location_id: string;
|
|
211
|
+
project_id: number;
|
|
212
|
+
reference_date: string;
|
|
213
|
+
};
|
|
214
|
+
|
|
215
|
+
type GetSavedAnnotationResponse = {
|
|
216
|
+
exists: boolean;
|
|
217
|
+
annotation_time_seconds: (number | null);
|
|
218
|
+
annotation: (AssetElement | null);
|
|
219
|
+
};
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Different ranks a user can have in a project
|
|
223
|
+
*/
|
|
224
|
+
declare enum UserRank {
|
|
225
|
+
MEMBER = "MEMBER",
|
|
226
|
+
ADMIN = "ADMIN",
|
|
227
|
+
OWNER = "OWNER"
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
type GetUserRoleProjectResponse = {
|
|
231
|
+
user_project: number;
|
|
232
|
+
user_rank: UserRank;
|
|
233
|
+
contract_start_date: (string | null);
|
|
234
|
+
contract_end_date: (string | null);
|
|
235
|
+
};
|
|
236
|
+
|
|
237
|
+
type ValidationError = {
|
|
238
|
+
loc: Array<(string | number)>;
|
|
239
|
+
msg: string;
|
|
240
|
+
type: string;
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
type HTTPValidationError = {
|
|
244
|
+
detail?: Array<ValidationError>;
|
|
245
|
+
};
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Response containing all the possible labels, either base labels or
|
|
249
|
+
* combination labels.
|
|
250
|
+
*/
|
|
251
|
+
type LabelsResponse = {
|
|
252
|
+
labels: Array<Record<string, any>>;
|
|
253
|
+
};
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Response containing all the available layers from the WMS service
|
|
257
|
+
*/
|
|
258
|
+
type LayersResponse = {
|
|
259
|
+
layers: Array<Record<string, string>>;
|
|
260
|
+
};
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Request sent for listing location points given a project
|
|
264
|
+
*/
|
|
265
|
+
type ListLocationsRequest = {
|
|
266
|
+
project_id: number;
|
|
267
|
+
minx: number;
|
|
268
|
+
miny: number;
|
|
269
|
+
maxx: number;
|
|
270
|
+
maxy: number;
|
|
271
|
+
only_annotated?: (boolean | null);
|
|
272
|
+
};
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Represents either a location or a cluster
|
|
276
|
+
*/
|
|
277
|
+
type LocationElement = {
|
|
278
|
+
location_id?: (string | null);
|
|
279
|
+
n_locations?: (number | null);
|
|
280
|
+
geometry: Record<string, any>;
|
|
281
|
+
};
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Response containing locations IDs or clusters of location
|
|
285
|
+
*/
|
|
286
|
+
type ListLocationsResponse = {
|
|
287
|
+
is_locations?: boolean;
|
|
288
|
+
elements: Array<LocationElement>;
|
|
289
|
+
};
|
|
290
|
+
|
|
291
|
+
type ProjectElement = {
|
|
292
|
+
project_id: number;
|
|
293
|
+
project_name: string;
|
|
294
|
+
creation_date: string;
|
|
295
|
+
project_owner: string;
|
|
296
|
+
n_locations: number;
|
|
297
|
+
is_deleted: boolean;
|
|
298
|
+
};
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* List of all the projects that an user is part of
|
|
302
|
+
*/
|
|
303
|
+
type ListProjectResponse = {
|
|
304
|
+
projects: Array<ProjectElement>;
|
|
305
|
+
};
|
|
306
|
+
|
|
307
|
+
type LocationAssetsResponse = {
|
|
308
|
+
assets: Array<AssetElement>;
|
|
309
|
+
};
|
|
310
|
+
|
|
311
|
+
type LocationResponse = {
|
|
312
|
+
geometry: Record<string, any>;
|
|
313
|
+
geometry_aoi: Record<string, any>;
|
|
314
|
+
epsg: number;
|
|
315
|
+
utm_bounds: Array<number>;
|
|
316
|
+
utm_bounds_aoi: Array<number>;
|
|
317
|
+
location_id: string;
|
|
318
|
+
unique_identifier: number;
|
|
319
|
+
has_area_of_interest: boolean;
|
|
320
|
+
meta_data?: (Record<string, any> | null);
|
|
321
|
+
};
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Response to the create location request. Says if the location was
|
|
325
|
+
* created or not and if it was created, also contains a PolygonResponse
|
|
326
|
+
* object, showing the location information.
|
|
327
|
+
*/
|
|
328
|
+
type LocationCreatedResponse = {
|
|
329
|
+
created: boolean;
|
|
330
|
+
location: (LocationResponse | null);
|
|
331
|
+
};
|
|
332
|
+
|
|
333
|
+
type LocationTaskAnnotationResponse = {
|
|
334
|
+
exists: boolean;
|
|
335
|
+
task_id: (number | null);
|
|
336
|
+
task_status: (string | null);
|
|
337
|
+
annotation: (AssetElement | null);
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Request to get the first location from the project that is either not
|
|
342
|
+
* started or not marked as finished
|
|
343
|
+
*/
|
|
344
|
+
type NextTaskRequest = {
|
|
345
|
+
project_id: number;
|
|
346
|
+
reference_date: string;
|
|
347
|
+
to_fix?: (boolean | null);
|
|
348
|
+
task_review?: (boolean | null);
|
|
349
|
+
};
|
|
350
|
+
|
|
351
|
+
type PolygonResponse = {
|
|
352
|
+
geometry: Record<string, any>;
|
|
353
|
+
epsg: number;
|
|
354
|
+
utm_bounds: Array<number>;
|
|
355
|
+
};
|
|
356
|
+
|
|
357
|
+
type ProjectDetailElement = {
|
|
358
|
+
project_id: number;
|
|
359
|
+
project_name: string;
|
|
360
|
+
project_reference_date: number;
|
|
361
|
+
project_type: string;
|
|
362
|
+
mixed_labels_level: number;
|
|
363
|
+
minimum_annotation: number;
|
|
364
|
+
maximum_annotation: number;
|
|
365
|
+
start_date: string;
|
|
366
|
+
end_date: (string | null);
|
|
367
|
+
creation_date: string;
|
|
368
|
+
project_owner: string;
|
|
369
|
+
current_active_group: number;
|
|
370
|
+
is_deleted: boolean;
|
|
371
|
+
n_locations: number;
|
|
372
|
+
meta_data?: (Record<string, any> | null);
|
|
373
|
+
tags?: (Array<string> | null);
|
|
374
|
+
};
|
|
375
|
+
|
|
376
|
+
type ProjectGroupResponse = {
|
|
377
|
+
group_name: string;
|
|
378
|
+
group_id: number;
|
|
379
|
+
n_locations: number;
|
|
380
|
+
is_active: boolean;
|
|
381
|
+
};
|
|
382
|
+
|
|
383
|
+
type Questionnaire = {
|
|
384
|
+
id: number;
|
|
385
|
+
project_id: number;
|
|
386
|
+
text: string;
|
|
387
|
+
type: string;
|
|
388
|
+
order_id: number;
|
|
389
|
+
has_dynamic_answers: boolean;
|
|
390
|
+
parent_question_id: (number | null);
|
|
391
|
+
answers: (Array<Answer> | null);
|
|
392
|
+
};
|
|
393
|
+
|
|
394
|
+
type RasterRequest = {
|
|
395
|
+
item_buffer: string;
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
type RemoveUserRequest = {
|
|
399
|
+
project_id: number;
|
|
400
|
+
user_id: string;
|
|
401
|
+
};
|
|
402
|
+
|
|
403
|
+
type SaveAnnotationRequest = {
|
|
404
|
+
task_id: number;
|
|
405
|
+
project_id: number;
|
|
406
|
+
base64_array: string;
|
|
407
|
+
array_width: number;
|
|
408
|
+
array_height: number;
|
|
409
|
+
annotation_time: number;
|
|
410
|
+
annotation_dates?: (Array<string> | null);
|
|
411
|
+
};
|
|
412
|
+
|
|
413
|
+
type SaveQuestionnaireRequest = {
|
|
414
|
+
task_id: number;
|
|
415
|
+
project_id: number;
|
|
416
|
+
questionnaire?: (Array<any[]> | null);
|
|
417
|
+
};
|
|
418
|
+
|
|
419
|
+
type SelectGroupRequest = {
|
|
420
|
+
project_id: number;
|
|
421
|
+
group_id: number;
|
|
422
|
+
};
|
|
423
|
+
|
|
424
|
+
type SetUserDetailRequest = {
|
|
425
|
+
user_id: string;
|
|
426
|
+
contract_start_date: (string | null);
|
|
427
|
+
contract_end_date: (string | null);
|
|
428
|
+
};
|
|
429
|
+
|
|
430
|
+
type SetUserRoleRequest = {
|
|
431
|
+
user_id: string;
|
|
432
|
+
project_id: number;
|
|
433
|
+
target_role: UserRank;
|
|
434
|
+
target_user_alias: string;
|
|
435
|
+
};
|
|
436
|
+
|
|
437
|
+
type TaskAnnotationResponse = {
|
|
438
|
+
exists: boolean;
|
|
439
|
+
annotation: (AssetElement | null);
|
|
440
|
+
};
|
|
441
|
+
|
|
442
|
+
type TaskChangeElement = {
|
|
443
|
+
id: number;
|
|
444
|
+
year_1: number;
|
|
445
|
+
year_2: number;
|
|
446
|
+
class_1: number;
|
|
447
|
+
class_2: number;
|
|
448
|
+
};
|
|
449
|
+
|
|
450
|
+
type TaskCommentRequest = {
|
|
451
|
+
task_id: number;
|
|
452
|
+
comment: string;
|
|
453
|
+
};
|
|
454
|
+
|
|
455
|
+
type TaskEventOut = {
|
|
456
|
+
task_id: number;
|
|
457
|
+
actor_id: string;
|
|
458
|
+
actor_alias: string;
|
|
459
|
+
event_type: string;
|
|
460
|
+
event_time: string;
|
|
461
|
+
content: string;
|
|
462
|
+
};
|
|
463
|
+
|
|
464
|
+
type TaskOut = {
|
|
465
|
+
task_id: number;
|
|
466
|
+
user_id: string;
|
|
467
|
+
user_alias: string;
|
|
468
|
+
location_id: string;
|
|
469
|
+
reference_date: string;
|
|
470
|
+
project_id: number;
|
|
471
|
+
project_type: (string | null);
|
|
472
|
+
location_group: string;
|
|
473
|
+
last_update_time: string;
|
|
474
|
+
status: string;
|
|
475
|
+
skip_reason?: (string | null);
|
|
476
|
+
annotation_asset?: (number | null);
|
|
477
|
+
saved_annotation?: (number | null);
|
|
478
|
+
transition_states?: Array<any[]>;
|
|
479
|
+
meta_data?: (Record<string, any> | null);
|
|
480
|
+
geometry_id?: (number | null);
|
|
481
|
+
change_id?: (number | null);
|
|
482
|
+
};
|
|
483
|
+
|
|
484
|
+
type TaskFilterResponse = {
|
|
485
|
+
tasks: Array<TaskOut>;
|
|
486
|
+
total_tasks: number;
|
|
487
|
+
};
|
|
488
|
+
|
|
489
|
+
type TaskGeometryElement = {
|
|
490
|
+
id: number;
|
|
491
|
+
identifier: string;
|
|
492
|
+
epsg: number;
|
|
493
|
+
geometry: (Record<string, any> | null);
|
|
494
|
+
type: string;
|
|
495
|
+
};
|
|
496
|
+
|
|
497
|
+
type TaskLatestCommentRequest = {
|
|
498
|
+
task_ids: Array<number>;
|
|
499
|
+
};
|
|
500
|
+
|
|
501
|
+
type TaskLatestCommentResponse = {
|
|
502
|
+
comments: Array<string>;
|
|
503
|
+
};
|
|
504
|
+
|
|
505
|
+
type TaskResponse = {
|
|
506
|
+
exists: boolean;
|
|
507
|
+
location: (LocationResponse | null);
|
|
508
|
+
task: (TaskOut | null);
|
|
509
|
+
};
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Enumerating the status of tasks
|
|
513
|
+
*/
|
|
514
|
+
declare enum TaskStatus {
|
|
515
|
+
ASSIGNED = "ASSIGNED",
|
|
516
|
+
SKIPPED = "SKIPPED",
|
|
517
|
+
USER_DISCARDED = "USER_DISCARDED",
|
|
518
|
+
DISCARDED = "DISCARDED",
|
|
519
|
+
IN_REVIEW = "IN_REVIEW",
|
|
520
|
+
SUBMITTED = "SUBMITTED",
|
|
521
|
+
TO_FIX = "TO_FIX",
|
|
522
|
+
ACCEPTED = "ACCEPTED"
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Type of task
|
|
527
|
+
*/
|
|
528
|
+
declare enum TaskType {
|
|
529
|
+
ANNOTATION = "ANNOTATION",
|
|
530
|
+
QUESTIONNAIRE = "QUESTIONNAIRE"
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
type TimeseriesElement = {
|
|
534
|
+
name: string;
|
|
535
|
+
assets: Array<AssetElement>;
|
|
536
|
+
reference_dates: Array<string>;
|
|
537
|
+
};
|
|
538
|
+
|
|
539
|
+
type TimeseriesInfoResponse = {
|
|
540
|
+
types: Array<TimeseriesElement>;
|
|
541
|
+
};
|
|
542
|
+
|
|
543
|
+
type UpdateTaskRequest = {
|
|
544
|
+
task_id: number;
|
|
545
|
+
project_id: number;
|
|
546
|
+
target_status: string;
|
|
547
|
+
task_type: Array<TaskType>;
|
|
548
|
+
base64_array?: (string | null);
|
|
549
|
+
array_width?: (number | null);
|
|
550
|
+
array_height?: (number | null);
|
|
551
|
+
annotation_time?: (number | null);
|
|
552
|
+
annotation_dates?: (Array<string> | null);
|
|
553
|
+
comment?: (string | null);
|
|
554
|
+
questionnaire?: (Array<any[]> | null);
|
|
555
|
+
};
|
|
556
|
+
|
|
557
|
+
type UpdateTaskResponse = {
|
|
558
|
+
success: boolean;
|
|
559
|
+
message: (string | null);
|
|
560
|
+
updated_task: TaskOut;
|
|
561
|
+
};
|
|
562
|
+
|
|
563
|
+
type UserOut = {
|
|
564
|
+
user_id: string;
|
|
565
|
+
user_alias: string;
|
|
566
|
+
contract_start_date: (string | null);
|
|
567
|
+
contract_end_date: (string | null);
|
|
568
|
+
};
|
|
569
|
+
|
|
570
|
+
type UserProjectElement = {
|
|
571
|
+
project_id: number;
|
|
572
|
+
project_name: string;
|
|
573
|
+
project_reference_date: number;
|
|
574
|
+
project_type: string;
|
|
575
|
+
mixed_labels_level: number;
|
|
576
|
+
minimum_annotation: number;
|
|
577
|
+
maximum_annotation: number;
|
|
578
|
+
start_date: string;
|
|
579
|
+
end_date: (string | null);
|
|
580
|
+
creation_date: string;
|
|
581
|
+
project_owner: string;
|
|
582
|
+
meta_data?: (Record<string, any> | null);
|
|
583
|
+
current_active_group: number;
|
|
584
|
+
is_deleted: boolean;
|
|
585
|
+
n_locations: number;
|
|
586
|
+
n_locations_group: number;
|
|
587
|
+
group_submitted_locations: number;
|
|
588
|
+
group_completed_locations: number;
|
|
589
|
+
proj_submitted_locations: number;
|
|
590
|
+
proj_completed_locations: number;
|
|
591
|
+
user_contributions: number;
|
|
592
|
+
user_labelled_locations: number;
|
|
593
|
+
user_tasks_in_review: number;
|
|
594
|
+
user_tasks_to_fix: number;
|
|
595
|
+
user_tasks_accepted: number;
|
|
596
|
+
user_discarded_tasks: number;
|
|
597
|
+
user_task_submitted: number;
|
|
598
|
+
project_tasks_in_review: number;
|
|
599
|
+
project_tasks_to_fix: number;
|
|
600
|
+
project_tasks_accepted: number;
|
|
601
|
+
};
|
|
602
|
+
|
|
603
|
+
type UserStatistic = {
|
|
604
|
+
user_id: string;
|
|
605
|
+
user_alias: string;
|
|
606
|
+
contract_start: (string | null);
|
|
607
|
+
contract_end: (string | null);
|
|
608
|
+
submitted_tasks: number;
|
|
609
|
+
in_review_tasks: number;
|
|
610
|
+
accepted_tasks: number;
|
|
611
|
+
skipped_tasks: number;
|
|
612
|
+
user_discarded_tasks: number;
|
|
613
|
+
discarded_tasks: number;
|
|
614
|
+
to_fix_tasks: number;
|
|
615
|
+
all_finished_tasks: number;
|
|
616
|
+
min_time: (number | null);
|
|
617
|
+
max_time: (number | null);
|
|
618
|
+
mean_time: (number | null);
|
|
619
|
+
};
|
|
620
|
+
|
|
621
|
+
type UserStatisticsResponse = {
|
|
622
|
+
start_date: string;
|
|
623
|
+
end_date: string;
|
|
624
|
+
project_id: number;
|
|
625
|
+
statistics: Array<UserStatistic>;
|
|
626
|
+
};
|
|
627
|
+
|
|
628
|
+
declare class AiService {
|
|
629
|
+
/**
|
|
630
|
+
* Performs an automatic annotation of a location based on provided inputs by user.
|
|
631
|
+
* @param requestBody
|
|
632
|
+
* @returns ActiveLearningResponse Successful Response
|
|
633
|
+
* @throws ApiError
|
|
634
|
+
*/
|
|
635
|
+
static performActiveLearningActivelearningPost(requestBody: ActiveLearningRequest): CancelablePromise<ActiveLearningResponse>;
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
declare class LocationService {
|
|
639
|
+
/**
|
|
640
|
+
* From a (lon, lat) coordinate and width and height expressed in meters, obtains a UTM tile of the given width and height for the best possible UTM projection. The user gets back the
|
|
641
|
+
* @param lon
|
|
642
|
+
* @param lat
|
|
643
|
+
* @param width
|
|
644
|
+
* @param height
|
|
645
|
+
* @returns PolygonResponse Successful Response
|
|
646
|
+
* @throws ApiError
|
|
647
|
+
*/
|
|
648
|
+
static getPolygonUtmlocationLonLonLatLatWidthWidthHeightHeightGet(lon: number, lat: number, width: number, height: number): CancelablePromise<PolygonResponse>;
|
|
649
|
+
/**
|
|
650
|
+
* From a location id, a project id and a reference date, gets a task response containing information about the location: the polygon with epsg and UTM bounds aligned in the grid. It also gets the task information for the user on that task if a task exists and is assigned to the current user.
|
|
651
|
+
* @param requestBody
|
|
652
|
+
* @returns TaskResponse Successful Response
|
|
653
|
+
* @throws ApiError
|
|
654
|
+
*/
|
|
655
|
+
static getLocationGetlocationPost(requestBody: GetLocationRequest): CancelablePromise<TaskResponse>;
|
|
656
|
+
/**
|
|
657
|
+
* Get the composite assets of a specific type from a location. Cannot get submitted annotations.
|
|
658
|
+
* @param requestBody
|
|
659
|
+
* @returns LocationAssetsResponse Successful Response
|
|
660
|
+
* @throws ApiError
|
|
661
|
+
*/
|
|
662
|
+
static getLocationAssetsLocationtypeassetsPost(requestBody: GetAssetsRequest): CancelablePromise<LocationAssetsResponse>;
|
|
663
|
+
/**
|
|
664
|
+
* Get all the assets for a given location.
|
|
665
|
+
* @param requestBody
|
|
666
|
+
* @returns LocationAssetsResponse Successful Response
|
|
667
|
+
* @throws ApiError
|
|
668
|
+
*/
|
|
669
|
+
static getAllAssetsLocationassetsPost(requestBody: GetLocationRequest): CancelablePromise<LocationAssetsResponse>;
|
|
670
|
+
/**
|
|
671
|
+
* Get a summary of the time series informations for a specific location.
|
|
672
|
+
* @param projectId
|
|
673
|
+
* @param locationId
|
|
674
|
+
* @returns TimeseriesInfoResponse Successful Response
|
|
675
|
+
* @throws ApiError
|
|
676
|
+
*/
|
|
677
|
+
static timeseriesInfoTimeseriesassetsProjectIdProjectIdLocationIdLocationIdGet(projectId: number, locationId: string): CancelablePromise<TimeseriesInfoResponse>;
|
|
678
|
+
/**
|
|
679
|
+
* Creates a location from a given lon/lat/width/height and project id. Only the admin and owner users can add a location to a project.
|
|
680
|
+
* @param requestBody
|
|
681
|
+
* @returns LocationCreatedResponse Successful Response
|
|
682
|
+
* @throws ApiError
|
|
683
|
+
*/
|
|
684
|
+
static createLocationCreatelocationPost(requestBody: CreateLocationRequest): CancelablePromise<LocationCreatedResponse>;
|
|
685
|
+
/**
|
|
686
|
+
* Process annotation bytes into tiff
|
|
687
|
+
* @param requestBody
|
|
688
|
+
* @returns any Successful Response
|
|
689
|
+
* @throws ApiError
|
|
690
|
+
*/
|
|
691
|
+
static processAnnotationProcessannotationPost(requestBody: AnnotationRequest): CancelablePromise<any>;
|
|
692
|
+
/**
|
|
693
|
+
* Process byte data into tiff
|
|
694
|
+
* @param requestBody
|
|
695
|
+
* @returns any Successful Response
|
|
696
|
+
* @throws ApiError
|
|
697
|
+
*/
|
|
698
|
+
static processRasterProcessrasterPost(requestBody: RasterRequest): CancelablePromise<any>;
|
|
699
|
+
/**
|
|
700
|
+
* Accepts a geojson, validates rows, insert in location_task_mapping and returns a json for each row's status
|
|
701
|
+
* @param formData
|
|
702
|
+
* @returns any Successful Response
|
|
703
|
+
* @throws ApiError
|
|
704
|
+
*/
|
|
705
|
+
static uploadLocationTaskUploadlocationtaskPost(formData: Body_upload_location_task_uploadlocationtask__post): CancelablePromise<Record<string, any>>;
|
|
706
|
+
/**
|
|
707
|
+
* Bulk Upload Locations
|
|
708
|
+
* Accepts a geojson, validates rows and insert in locations table, returns status of inserted and error row
|
|
709
|
+
* @param formData
|
|
710
|
+
* @returns any Successful Response
|
|
711
|
+
* @throws ApiError
|
|
712
|
+
*/
|
|
713
|
+
static bulkUploadLocationsUploadlocationsPost(formData: Body_bulk_upload_locations_uploadlocations__post): CancelablePromise<Record<string, any>>;
|
|
714
|
+
/**
|
|
715
|
+
* Bulk Upload Review Tasks
|
|
716
|
+
* Upload tasks which has been selected for review
|
|
717
|
+
* @param formData
|
|
718
|
+
* @returns any Successful Response
|
|
719
|
+
* @throws ApiError
|
|
720
|
+
*/
|
|
721
|
+
static bulkUploadReviewTasksUploadreviewtasksPost(formData: Body_bulk_upload_review_tasks_uploadreviewtasks_post): CancelablePromise<Record<string, any>>;
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
declare class ProjectService {
|
|
725
|
+
/**
|
|
726
|
+
* Read Root
|
|
727
|
+
* @returns AboutResponse Successful Response
|
|
728
|
+
* @throws ApiError
|
|
729
|
+
*/
|
|
730
|
+
static readRootGet(): CancelablePromise<AboutResponse>;
|
|
731
|
+
/**
|
|
732
|
+
* Get personal information by decoding the user token (specified inside the Authorization header field).
|
|
733
|
+
* @returns any Successful Response
|
|
734
|
+
* @throws ApiError
|
|
735
|
+
*/
|
|
736
|
+
static getUserMeGet(): CancelablePromise<any>;
|
|
737
|
+
/**
|
|
738
|
+
* Returns the available layers from the WMS service.
|
|
739
|
+
* @returns LayersResponse Successful Response
|
|
740
|
+
* @throws ApiError
|
|
741
|
+
*/
|
|
742
|
+
static getAvailableLayersAvailablelayersGet(): CancelablePromise<LayersResponse>;
|
|
743
|
+
/**
|
|
744
|
+
* Return the WC labels codes for a project, with their names and colors.
|
|
745
|
+
* @param projectId
|
|
746
|
+
* @returns LabelsResponse Successful Response
|
|
747
|
+
* @throws ApiError
|
|
748
|
+
*/
|
|
749
|
+
static getLabelsLabelsProjectIdProjectIdGet(projectId: number): CancelablePromise<LabelsResponse>;
|
|
750
|
+
/**
|
|
751
|
+
* Return the combinatory (primary/secondary/tertiary) label codes, with their names and colors.
|
|
752
|
+
* @param projectId
|
|
753
|
+
* @returns LabelsResponse Successful Response
|
|
754
|
+
* @throws ApiError
|
|
755
|
+
*/
|
|
756
|
+
static getCombinationLabelsCombinationlabelsProjectIdProjectIdGet(projectId: number): CancelablePromise<LabelsResponse>;
|
|
757
|
+
/**
|
|
758
|
+
* Get the project information from a specific project.
|
|
759
|
+
* @param projectId
|
|
760
|
+
* @returns ProjectDetailElement Successful Response
|
|
761
|
+
* @throws ApiError
|
|
762
|
+
*/
|
|
763
|
+
static projectDetailProjectdetailProjectIdProjectIdGet(projectId: number): CancelablePromise<ProjectDetailElement>;
|
|
764
|
+
/**
|
|
765
|
+
* Get the project information, user statistics from a specific project.
|
|
766
|
+
* @param projectId
|
|
767
|
+
* @returns UserProjectElement Successful Response
|
|
768
|
+
* @throws ApiError
|
|
769
|
+
*/
|
|
770
|
+
static projectInfoProjectinfoProjectIdProjectIdGet(projectId: number): CancelablePromise<UserProjectElement>;
|
|
771
|
+
/**
|
|
772
|
+
* Lists all the project that the user is part of. If the user is an administrator, then lists all the projects currently in the datbase, including the deleted projects.
|
|
773
|
+
* @param startidx
|
|
774
|
+
* @param amount
|
|
775
|
+
* @returns ListProjectResponse Successful Response
|
|
776
|
+
* @throws ApiError
|
|
777
|
+
*/
|
|
778
|
+
static listProjectsListprojectsStartidxStartidxAmountAmountGet(startidx: number, amount: number): CancelablePromise<ListProjectResponse>;
|
|
779
|
+
/**
|
|
780
|
+
* Creates a project, adding the curent user as owner. Only GeoWiki admins can create a new project.
|
|
781
|
+
* @param requestBody
|
|
782
|
+
* @returns CreateProjectResponse Successful Response
|
|
783
|
+
* @throws ApiError
|
|
784
|
+
*/
|
|
785
|
+
static createProjectCreateprojectPost(requestBody: CreateProjectRequest): CancelablePromise<CreateProjectResponse>;
|
|
786
|
+
/**
|
|
787
|
+
* Get the project result set information for all the location and tasks linked to a project
|
|
788
|
+
* @param projectId
|
|
789
|
+
* @param isGeoJson
|
|
790
|
+
* @returns any Successful Response
|
|
791
|
+
* @throws ApiError
|
|
792
|
+
*/
|
|
793
|
+
static projectResultSetProjectresultsetProjectIdProjectIdIsGeoJsonIsGeoJsonGet(projectId: number, isGeoJson: boolean): CancelablePromise<any>;
|
|
794
|
+
/**
|
|
795
|
+
* Create a new user in the database. Only admins can create a new user.
|
|
796
|
+
* @param requestBody
|
|
797
|
+
* @returns GenericResponse Successful Response
|
|
798
|
+
* @throws ApiError
|
|
799
|
+
*/
|
|
800
|
+
static createUserCreateuserPost(requestBody: CreateUserRequest): CancelablePromise<GenericResponse>;
|
|
801
|
+
/**
|
|
802
|
+
* Sets the user role in a project. If the user does not exists, then adds it to the project with the target role.
|
|
803
|
+
* @param requestBody
|
|
804
|
+
* @returns GenericResponse Successful Response
|
|
805
|
+
* @throws ApiError
|
|
806
|
+
*/
|
|
807
|
+
static setUserRoleSetuserrolePost(requestBody: Array<SetUserRoleRequest>): CancelablePromise<GenericResponse>;
|
|
808
|
+
/**
|
|
809
|
+
* Sets the user role in a project. If the user does not exists, then adds it to the project with the target role.
|
|
810
|
+
* @param requestBody
|
|
811
|
+
* @returns GenericResponse Successful Response
|
|
812
|
+
* @throws ApiError
|
|
813
|
+
*/
|
|
814
|
+
static setUserDetailSetuserdetailPost(requestBody: SetUserDetailRequest): CancelablePromise<GenericResponse>;
|
|
815
|
+
/**
|
|
816
|
+
* Get user role and project
|
|
817
|
+
* @param userId
|
|
818
|
+
* @returns GetUserRoleProjectResponse Successful Response
|
|
819
|
+
* @throws ApiError
|
|
820
|
+
*/
|
|
821
|
+
static getUserRoleProjectGetuserroleprojectUserIdUserIdGet(userId: string): CancelablePromise<Array<GetUserRoleProjectResponse>>;
|
|
822
|
+
/**
|
|
823
|
+
* Removes an user from a project.
|
|
824
|
+
* @param requestBody
|
|
825
|
+
* @returns GenericResponse Successful Response
|
|
826
|
+
* @throws ApiError
|
|
827
|
+
*/
|
|
828
|
+
static removeUserRemoveuserPost(requestBody: RemoveUserRequest): CancelablePromise<GenericResponse>;
|
|
829
|
+
/**
|
|
830
|
+
* Returns a set of locations, or a sets of clusters given a bounding box
|
|
831
|
+
* @param requestBody
|
|
832
|
+
* @returns ListLocationsResponse Successful Response
|
|
833
|
+
* @throws ApiError
|
|
834
|
+
*/
|
|
835
|
+
static searchLocationsLocationsPost(requestBody: ListLocationsRequest): CancelablePromise<ListLocationsResponse>;
|
|
836
|
+
/**
|
|
837
|
+
* Returns a summary of locations,groups
|
|
838
|
+
* @param projectId
|
|
839
|
+
* @returns any Successful Response
|
|
840
|
+
* @throws ApiError
|
|
841
|
+
*/
|
|
842
|
+
static getLocationsSummaryLocationssummaryProjectIdProjectIdGet(projectId: number): CancelablePromise<any>;
|
|
843
|
+
/**
|
|
844
|
+
* Get the table of tasks of the user if an user is specified.
|
|
845
|
+
* @param locationProjectId
|
|
846
|
+
* @param taskForReview
|
|
847
|
+
* @param id
|
|
848
|
+
* @param orderBy
|
|
849
|
+
* @param search
|
|
850
|
+
* @param status
|
|
851
|
+
* @param statusIn
|
|
852
|
+
* @param dateLte
|
|
853
|
+
* @param dateGte
|
|
854
|
+
* @param pageIdx
|
|
855
|
+
* @param pageSize
|
|
856
|
+
* @param userId
|
|
857
|
+
* @param userUserAlias
|
|
858
|
+
* @param userOrderBy
|
|
859
|
+
* @param locationLocationId
|
|
860
|
+
* @param locationOrderBy
|
|
861
|
+
* @param groupName
|
|
862
|
+
* @param groupOrderBy
|
|
863
|
+
* @returns TaskFilterResponse Successful Response
|
|
864
|
+
* @throws ApiError
|
|
865
|
+
*/
|
|
866
|
+
static getTasksTasksGet(locationProjectId: number, taskForReview?: (boolean | null), id?: (number | null), orderBy?: (string | null), search?: (string | null), status?: (TaskStatus | null), statusIn?: (string | null), dateLte?: (string | null), dateGte?: (string | null), pageIdx?: (number | null), pageSize?: (number | null), userId?: (string | null), userUserAlias?: (string | null), userOrderBy?: (string | null), locationLocationId?: (string | null), locationOrderBy?: (string | null), groupName?: (string | null), groupOrderBy?: (string | null)): CancelablePromise<TaskFilterResponse>;
|
|
867
|
+
/**
|
|
868
|
+
* Get a random task for the user, based on the same filter available in the GET /tasks call.
|
|
869
|
+
* @param locationProjectId
|
|
870
|
+
* @param taskForReview
|
|
871
|
+
* @param id
|
|
872
|
+
* @param orderBy
|
|
873
|
+
* @param search
|
|
874
|
+
* @param status
|
|
875
|
+
* @param statusIn
|
|
876
|
+
* @param dateLte
|
|
877
|
+
* @param dateGte
|
|
878
|
+
* @param pageIdx
|
|
879
|
+
* @param pageSize
|
|
880
|
+
* @param userId
|
|
881
|
+
* @param userUserAlias
|
|
882
|
+
* @param userOrderBy
|
|
883
|
+
* @param locationLocationId
|
|
884
|
+
* @param locationOrderBy
|
|
885
|
+
* @param groupName
|
|
886
|
+
* @param groupOrderBy
|
|
887
|
+
* @returns TaskResponse Successful Response
|
|
888
|
+
* @throws ApiError
|
|
889
|
+
*/
|
|
890
|
+
static getRandomTaskRandomtaskGet(locationProjectId: number, taskForReview?: (boolean | null), id?: (number | null), orderBy?: (string | null), search?: (string | null), status?: (TaskStatus | null), statusIn?: (string | null), dateLte?: (string | null), dateGte?: (string | null), pageIdx?: (number | null), pageSize?: (number | null), userId?: (string | null), userUserAlias?: (string | null), userOrderBy?: (string | null), locationLocationId?: (string | null), locationOrderBy?: (string | null), groupName?: (string | null), groupOrderBy?: (string | null)): CancelablePromise<TaskResponse>;
|
|
891
|
+
/**
|
|
892
|
+
* Returns a list of groups available within a project.
|
|
893
|
+
* @param projectId
|
|
894
|
+
* @returns ProjectGroupResponse Successful Response
|
|
895
|
+
* @throws ApiError
|
|
896
|
+
*/
|
|
897
|
+
static getProjectGroupsProjectgroupsProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<ProjectGroupResponse>>;
|
|
898
|
+
/**
|
|
899
|
+
* Selects an active group for a project.
|
|
900
|
+
* @param requestBody
|
|
901
|
+
* @returns GenericResponse Successful Response
|
|
902
|
+
* @throws ApiError
|
|
903
|
+
*/
|
|
904
|
+
static selectProjectGroupProjectselectgroupPost(requestBody: SelectGroupRequest): CancelablePromise<GenericResponse>;
|
|
905
|
+
/**
|
|
906
|
+
* List all the users within a project.
|
|
907
|
+
* @param projectId
|
|
908
|
+
* @returns UserOut Successful Response
|
|
909
|
+
* @throws ApiError
|
|
910
|
+
*/
|
|
911
|
+
static projectAllUsersProjectusersProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<UserOut>>;
|
|
912
|
+
/**
|
|
913
|
+
* Returns the task information for a specific location. The task returned is the task with the latest update.
|
|
914
|
+
* @param locationId
|
|
915
|
+
* @param projectId
|
|
916
|
+
* @param referenceDate
|
|
917
|
+
* @returns LocationTaskAnnotationResponse Successful Response
|
|
918
|
+
* @throws ApiError
|
|
919
|
+
*/
|
|
920
|
+
static locationLatestTaskLocationtaskLocationIdLocationIdProjectIdProjectIdReferenceDateReferenceDateGet(locationId: string, projectId: number, referenceDate: string): CancelablePromise<LocationTaskAnnotationResponse>;
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
declare class QuestionService {
|
|
924
|
+
/**
|
|
925
|
+
* Get Project Questions Answers
|
|
926
|
+
* get pairs of questions and answers associated with a project
|
|
927
|
+
* @param projectId
|
|
928
|
+
* @returns Questionnaire Successful Response
|
|
929
|
+
* @throws ApiError
|
|
930
|
+
*/
|
|
931
|
+
static getProjectQuestionsAnswersQuestionsAnswersProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<Questionnaire>>;
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
declare class StatisticService {
|
|
935
|
+
/**
|
|
936
|
+
* Get User Statistics
|
|
937
|
+
* For each user within a project, get statistics related to the tasks that were updated.
|
|
938
|
+
* @param projectId
|
|
939
|
+
* @param endDate
|
|
940
|
+
* @param startDate
|
|
941
|
+
* @param isContractualData
|
|
942
|
+
* @param filterUserId
|
|
943
|
+
* @returns UserStatisticsResponse Successful Response
|
|
944
|
+
* @throws ApiError
|
|
945
|
+
*/
|
|
946
|
+
static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateFilterUserIdFilterUserIdIsContractualDataIsContractualDataGet(projectId: number, endDate: string, startDate: (string | null), isContractualData: boolean, filterUserId: (string | null)): CancelablePromise<UserStatisticsResponse>;
|
|
947
|
+
/**
|
|
948
|
+
* Get User Statistics
|
|
949
|
+
* For each user within a project, get statistics related to the tasks that were updated.
|
|
950
|
+
* @param projectId
|
|
951
|
+
* @param endDate
|
|
952
|
+
* @param startDate
|
|
953
|
+
* @param filterUserId
|
|
954
|
+
* @param isContractualData
|
|
955
|
+
* @returns UserStatisticsResponse Successful Response
|
|
956
|
+
* @throws ApiError
|
|
957
|
+
*/
|
|
958
|
+
static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateFilterUserIdFilterUserIdGet(projectId: number, endDate: string, startDate: (string | null), filterUserId: (string | null), isContractualData?: boolean): CancelablePromise<UserStatisticsResponse>;
|
|
959
|
+
/**
|
|
960
|
+
* Get User Statistics
|
|
961
|
+
* For each user within a project, get statistics related to the tasks that were updated.
|
|
962
|
+
* @param projectId
|
|
963
|
+
* @param endDate
|
|
964
|
+
* @param startDate
|
|
965
|
+
* @param isContractualData
|
|
966
|
+
* @param filterUserId
|
|
967
|
+
* @returns UserStatisticsResponse Successful Response
|
|
968
|
+
* @throws ApiError
|
|
969
|
+
*/
|
|
970
|
+
static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateGet(projectId: number, endDate: string, startDate: (string | null), isContractualData?: boolean, filterUserId?: (string | null)): CancelablePromise<UserStatisticsResponse>;
|
|
971
|
+
}
|
|
972
|
+
|
|
973
|
+
declare class TaskService {
|
|
974
|
+
/**
|
|
975
|
+
* Get all the possible task statuses
|
|
976
|
+
* @returns string Successful Response
|
|
977
|
+
* @throws ApiError
|
|
978
|
+
*/
|
|
979
|
+
static getTaskStatusesTaskstatusesGet(): CancelablePromise<Array<string>>;
|
|
980
|
+
/**
|
|
981
|
+
* Get the task information for a specific task id.
|
|
982
|
+
* @param taskId
|
|
983
|
+
* @returns TaskResponse Successful Response
|
|
984
|
+
* @throws ApiError
|
|
985
|
+
*/
|
|
986
|
+
static getTaskGettaskTaskIdTaskIdGet(taskId: number): CancelablePromise<TaskResponse>;
|
|
987
|
+
/**
|
|
988
|
+
* Create a task for an user for a specific location, if no task exists for that user on that location. Then returns the created/existing task and location info.
|
|
989
|
+
* @param requestBody
|
|
990
|
+
* @returns TaskResponse Successful Response
|
|
991
|
+
* @throws ApiError
|
|
992
|
+
*/
|
|
993
|
+
static createTaskCreatetaskPost(requestBody: CreateTaskRequest): CancelablePromise<TaskResponse>;
|
|
994
|
+
/**
|
|
995
|
+
* Returns a new task for an user on a new location. If the user already has a task in the ASSIGNED state, it will be returned.
|
|
996
|
+
* @param requestBody
|
|
997
|
+
* @returns TaskResponse Successful Response
|
|
998
|
+
* @throws ApiError
|
|
999
|
+
*/
|
|
1000
|
+
static getNextLocationNexttaskPost(requestBody: NextTaskRequest): CancelablePromise<TaskResponse>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Deletes a specific task from the database and the related events. Submitted annotations are kept in the database for the location. Only admin users can delete tasks.
|
|
1003
|
+
* @param requestBody
|
|
1004
|
+
* @returns GenericResponse Successful Response
|
|
1005
|
+
* @throws ApiError
|
|
1006
|
+
*/
|
|
1007
|
+
static deleteTaskDeletetaskPost(requestBody: DeleteTaskRequest): CancelablePromise<GenericResponse>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Get the latest task annotation for a specific task id.
|
|
1010
|
+
* @param taskId
|
|
1011
|
+
* @returns TaskAnnotationResponse Successful Response
|
|
1012
|
+
* @throws ApiError
|
|
1013
|
+
*/
|
|
1014
|
+
static getTaskAnnotationAssetTaskannotationTaskIdTaskIdGet(taskId: number): CancelablePromise<TaskAnnotationResponse>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Get all the annotations for a specific task id.
|
|
1017
|
+
* @param taskId
|
|
1018
|
+
* @returns LocationAssetsResponse Successful Response
|
|
1019
|
+
* @throws ApiError
|
|
1020
|
+
*/
|
|
1021
|
+
static getTaskAnnotationAssetsTaskannotationsTaskIdTaskIdGet(taskId: number): CancelablePromise<LocationAssetsResponse>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Saves an annotation for a task.
|
|
1024
|
+
* @param requestBody
|
|
1025
|
+
* @returns GenericResponse Successful Response
|
|
1026
|
+
* @throws ApiError
|
|
1027
|
+
*/
|
|
1028
|
+
static saveAnnotationSaveannotationPost(requestBody: SaveAnnotationRequest): CancelablePromise<GenericResponse>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Get the saved annotation for a specific task (if it exists).
|
|
1031
|
+
* @param taskId
|
|
1032
|
+
* @returns GetSavedAnnotationResponse Successful Response
|
|
1033
|
+
* @throws ApiError
|
|
1034
|
+
*/
|
|
1035
|
+
static getSavedAnnotationGetsavedannotationTaskIdTaskIdGet(taskId: number): CancelablePromise<GetSavedAnnotationResponse>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Save Questionnaire
|
|
1038
|
+
* Save questionnaire for a task
|
|
1039
|
+
* @param requestBody
|
|
1040
|
+
* @returns GenericResponse Successful Response
|
|
1041
|
+
* @throws ApiError
|
|
1042
|
+
*/
|
|
1043
|
+
static saveQuestionnaireSavequestionnairePost(requestBody: SaveQuestionnaireRequest): CancelablePromise<GenericResponse>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Get change detection details associated with a task
|
|
1046
|
+
* @param taskId
|
|
1047
|
+
* @returns TaskChangeElement Successful Response
|
|
1048
|
+
* @throws ApiError
|
|
1049
|
+
*/
|
|
1050
|
+
static getTaskChangeDetailTaskchangedetailsPost(taskId: number): CancelablePromise<TaskChangeElement>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Get change detection details associated with a task
|
|
1053
|
+
* @param taskId
|
|
1054
|
+
* @returns TaskGeometryElement Successful Response
|
|
1055
|
+
* @throws ApiError
|
|
1056
|
+
*/
|
|
1057
|
+
static getTaskGeometryDetailTaskgeometryetailsPost(taskId: number): CancelablePromise<TaskGeometryElement>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Updates the status of a task. Depending on the previous status, the role of the user and the target status, required required parameters may vary
|
|
1060
|
+
* @param requestBody
|
|
1061
|
+
* @returns UpdateTaskResponse Successful Response
|
|
1062
|
+
* @throws ApiError
|
|
1063
|
+
*/
|
|
1064
|
+
static updateTaskUpdatetaskPost(requestBody: UpdateTaskRequest): CancelablePromise<UpdateTaskResponse>;
|
|
1065
|
+
/**
|
|
1066
|
+
* Adds a comment from an user on a task.
|
|
1067
|
+
* @param requestBody
|
|
1068
|
+
* @returns GenericResponse Successful Response
|
|
1069
|
+
* @throws ApiError
|
|
1070
|
+
*/
|
|
1071
|
+
static taskCommentTaskcommentPost(requestBody: TaskCommentRequest): CancelablePromise<GenericResponse>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Get the events of a task.
|
|
1074
|
+
* @param taskId
|
|
1075
|
+
* @returns TaskEventOut Successful Response
|
|
1076
|
+
* @throws ApiError
|
|
1077
|
+
*/
|
|
1078
|
+
static getTaskEventsTaskeventsTaskIdTaskIdGet(taskId: number): CancelablePromise<Array<TaskEventOut>>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Get the latest comments for every task in the provided list. The response will be a list of comments ordered in the same way as the input list. An empty string is returned if no latest comment was found.
|
|
1081
|
+
* @param requestBody
|
|
1082
|
+
* @returns TaskLatestCommentResponse Successful Response
|
|
1083
|
+
* @throws ApiError
|
|
1084
|
+
*/
|
|
1085
|
+
static taskLatestComomentsTasklatestcommentPost(requestBody: TaskLatestCommentRequest): CancelablePromise<TaskLatestCommentResponse>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Get the reference dates for current task on a location from meta_data.The response model will be a list of string
|
|
1088
|
+
* @param locationId
|
|
1089
|
+
* @param projectId
|
|
1090
|
+
* @param assetType
|
|
1091
|
+
* @returns any Successful Response
|
|
1092
|
+
* @throws ApiError
|
|
1093
|
+
*/
|
|
1094
|
+
static taskReferenceDatesGettaskreferencedatesProjectIdProjectIdLocationIdLocationIdAssetTypeAssetTypeGet(locationId: string, projectId: number, assetType: string): CancelablePromise<(Array<string> | null)>;
|
|
1095
|
+
/**
|
|
1096
|
+
* returns a list of user provided answers associated with a task
|
|
1097
|
+
* @param taskId
|
|
1098
|
+
* @returns any[] Successful Response
|
|
1099
|
+
* @throws ApiError
|
|
1100
|
+
*/
|
|
1101
|
+
static getTaskAnswersTaskanswersTaskIdTaskIdGet(taskId: number): CancelablePromise<Array<any[]>>;
|
|
1102
|
+
}
|
|
1103
|
+
|
|
1104
|
+
export { type AboutResponse, type ActiveLearningRequest, type ActiveLearningResponse, AiService, type AnnotationRequest, type Answer, ApiError, type AssetElement, type Body_bulk_upload_locations_uploadlocations__post, type Body_bulk_upload_review_tasks_uploadreviewtasks_post, type Body_upload_location_task_uploadlocationtask__post, CancelError, CancelablePromise, type CreateLocationRequest, type CreateProjectRequest, type CreateProjectResponse, type CreateTaskRequest, type CreateUserRequest, type DeleteTaskRequest, type GenericResponse, type GetAssetsRequest, type GetLocationRequest, type GetSavedAnnotationResponse, type GetUserRoleProjectResponse, type HTTPValidationError, type LabelsResponse, type LayersResponse, type ListLocationsRequest, type ListLocationsResponse, type ListProjectResponse, type LocationAssetsResponse, type LocationCreatedResponse, type LocationElement, type LocationResponse, LocationService, type LocationTaskAnnotationResponse, type NextTaskRequest, OpenAPI, type OpenAPIConfig, type PolygonResponse, type ProjectDetailElement, type ProjectElement, type ProjectGroupResponse, ProjectService, QuestionService, type Questionnaire, type RasterRequest, type RemoveUserRequest, type SaveAnnotationRequest, type SaveQuestionnaireRequest, type SelectGroupRequest, type SetUserDetailRequest, type SetUserRoleRequest, StatisticService, type TaskAnnotationResponse, type TaskChangeElement, type TaskCommentRequest, type TaskEventOut, type TaskFilterResponse, type TaskGeometryElement, type TaskLatestCommentRequest, type TaskLatestCommentResponse, type TaskOut, type TaskResponse, TaskService, TaskStatus, TaskType, type TimeseriesElement, type TimeseriesInfoResponse, type UpdateTaskRequest, type UpdateTaskResponse, type UserOut, type UserProjectElement, UserRank, type UserStatistic, type UserStatisticsResponse, type ValidationError };
|