@geowiki/evoland-api-proxy 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1107 @@
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
+ asset_url: (string | null);
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: string;
121
+ project_id: number;
122
+ group_id: number;
123
+ };
124
+
125
+ type Body_bulk_upload_review_tasks_uploadreviewtasks_post = {
126
+ file: string;
127
+ project_id: number;
128
+ };
129
+
130
+ type Body_upload_location_task_uploadlocationtask__post = {
131
+ file: string;
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
+ input?: any;
242
+ ctx?: Record<string, any>;
243
+ };
244
+
245
+ type HTTPValidationError = {
246
+ detail?: Array<ValidationError>;
247
+ };
248
+
249
+ /**
250
+ * Response containing all the possible labels, either base labels or
251
+ * combination labels.
252
+ */
253
+ type LabelsResponse = {
254
+ labels: Array<Record<string, any>>;
255
+ };
256
+
257
+ /**
258
+ * Response containing all the available layers from the WMS service
259
+ */
260
+ type LayersResponse = {
261
+ layers: Array<Record<string, string>>;
262
+ };
263
+
264
+ /**
265
+ * Request sent for listing location points given a project
266
+ */
267
+ type ListLocationsRequest = {
268
+ project_id: number;
269
+ minx: number;
270
+ miny: number;
271
+ maxx: number;
272
+ maxy: number;
273
+ only_annotated?: (boolean | null);
274
+ };
275
+
276
+ /**
277
+ * Represents either a location or a cluster
278
+ */
279
+ type LocationElement = {
280
+ location_id?: (string | null);
281
+ n_locations?: (number | null);
282
+ geometry: Record<string, any>;
283
+ };
284
+
285
+ /**
286
+ * Response containing locations IDs or clusters of location
287
+ */
288
+ type ListLocationsResponse = {
289
+ is_locations?: boolean;
290
+ elements: Array<LocationElement>;
291
+ };
292
+
293
+ type ProjectElement = {
294
+ project_id: number;
295
+ project_name: string;
296
+ creation_date: string;
297
+ project_owner: string;
298
+ n_locations: number;
299
+ is_deleted: boolean;
300
+ };
301
+
302
+ /**
303
+ * List of all the projects that an user is part of
304
+ */
305
+ type ListProjectResponse = {
306
+ projects: Array<ProjectElement>;
307
+ };
308
+
309
+ type LocationAssetsResponse = {
310
+ assets: Array<AssetElement>;
311
+ };
312
+
313
+ type LocationResponse = {
314
+ geometry: Record<string, any>;
315
+ geometry_aoi: Record<string, any>;
316
+ epsg: number;
317
+ utm_bounds: Array<number>;
318
+ utm_bounds_aoi: Array<number>;
319
+ location_id: string;
320
+ unique_identifier: number;
321
+ has_area_of_interest: boolean;
322
+ meta_data?: (Record<string, any> | null);
323
+ };
324
+
325
+ /**
326
+ * Response to the create location request. Says if the location was
327
+ * created or not and if it was created, also contains a PolygonResponse
328
+ * object, showing the location information.
329
+ */
330
+ type LocationCreatedResponse = {
331
+ created: boolean;
332
+ location: (LocationResponse | null);
333
+ };
334
+
335
+ type LocationTaskAnnotationResponse = {
336
+ exists: boolean;
337
+ task_id: (number | null);
338
+ task_status: (string | null);
339
+ annotation: (AssetElement | null);
340
+ };
341
+
342
+ /**
343
+ * Request to get the first location from the project that is either not
344
+ * started or not marked as finished
345
+ */
346
+ type NextTaskRequest = {
347
+ project_id: number;
348
+ reference_date: string;
349
+ to_fix?: (boolean | null);
350
+ task_review?: (boolean | null);
351
+ };
352
+
353
+ type PolygonResponse = {
354
+ geometry: Record<string, any>;
355
+ epsg: number;
356
+ utm_bounds: Array<number>;
357
+ };
358
+
359
+ type ProjectDetailElement = {
360
+ project_id: number;
361
+ project_name: string;
362
+ project_reference_date: number;
363
+ project_type: string;
364
+ mixed_labels_level: number;
365
+ minimum_annotation: number;
366
+ maximum_annotation: number;
367
+ start_date: string;
368
+ end_date: (string | null);
369
+ creation_date: string;
370
+ project_owner: string;
371
+ current_active_group: number;
372
+ is_deleted: boolean;
373
+ n_locations: number;
374
+ meta_data?: (Record<string, any> | null);
375
+ tags?: (Array<string> | null);
376
+ };
377
+
378
+ type ProjectGroupResponse = {
379
+ group_name: string;
380
+ group_id: number;
381
+ n_locations: number;
382
+ n_locations_annotated: number;
383
+ is_active: boolean;
384
+ };
385
+
386
+ type Questionnaire = {
387
+ id: number;
388
+ project_id: number;
389
+ text: string;
390
+ type: string;
391
+ order_id: number;
392
+ has_dynamic_answers: boolean;
393
+ parent_question_id: (number | null);
394
+ answers: (Array<Answer> | null);
395
+ };
396
+
397
+ type RasterRequest = {
398
+ asset_url: (string | null);
399
+ };
400
+
401
+ type RemoveUserRequest = {
402
+ project_id: number;
403
+ user_id: string;
404
+ };
405
+
406
+ type SaveAnnotationRequest = {
407
+ task_id: number;
408
+ project_id: number;
409
+ base64_array: string;
410
+ array_width: number;
411
+ array_height: number;
412
+ annotation_time: number;
413
+ annotation_dates?: (Array<string> | null);
414
+ };
415
+
416
+ type SaveQuestionnaireRequest = {
417
+ task_id: number;
418
+ project_id: number;
419
+ questionnaire?: (Array<any[]> | null);
420
+ };
421
+
422
+ type SelectGroupRequest = {
423
+ project_id: number;
424
+ group_id: number;
425
+ };
426
+
427
+ type SetUserDetailRequest = {
428
+ user_id: string;
429
+ contract_start_date: (string | null);
430
+ contract_end_date: (string | null);
431
+ };
432
+
433
+ type SetUserRoleRequest = {
434
+ user_id: string;
435
+ project_id: number;
436
+ target_role: UserRank;
437
+ target_user_alias: string;
438
+ };
439
+
440
+ type TaskAnnotationResponse = {
441
+ exists: boolean;
442
+ annotation: (AssetElement | null);
443
+ };
444
+
445
+ type TaskChangeElement = {
446
+ id: number;
447
+ year_1: number;
448
+ year_2: number;
449
+ class_1: number;
450
+ class_2: number;
451
+ };
452
+
453
+ type TaskCommentRequest = {
454
+ task_id: number;
455
+ comment: string;
456
+ };
457
+
458
+ type TaskEventOut = {
459
+ task_id: number;
460
+ actor_id: string;
461
+ actor_alias: string;
462
+ event_type: string;
463
+ event_time: string;
464
+ content: string;
465
+ };
466
+
467
+ type TaskOut = {
468
+ task_id: number;
469
+ user_id: string;
470
+ user_alias: string;
471
+ location_id: string;
472
+ reference_date: string;
473
+ project_id: number;
474
+ project_type: (string | null);
475
+ location_group: string;
476
+ last_update_time: string;
477
+ status: string;
478
+ skip_reason?: (string | null);
479
+ annotation_asset?: (number | null);
480
+ saved_annotation?: (number | null);
481
+ transition_states?: Array<any[]>;
482
+ meta_data?: (Record<string, any> | null);
483
+ geometry_id?: (number | null);
484
+ change_id?: (number | null);
485
+ };
486
+
487
+ type TaskFilterResponse = {
488
+ tasks: Array<TaskOut>;
489
+ total_tasks: number;
490
+ };
491
+
492
+ type TaskGeometryElement = {
493
+ id: number;
494
+ identifier: string;
495
+ epsg: number;
496
+ geometry: (Record<string, any> | null);
497
+ type: string;
498
+ };
499
+
500
+ type TaskLatestCommentRequest = {
501
+ task_ids: Array<number>;
502
+ };
503
+
504
+ type TaskLatestCommentResponse = {
505
+ comments: Array<string>;
506
+ };
507
+
508
+ type TaskResponse = {
509
+ exists: boolean;
510
+ location: (LocationResponse | null);
511
+ task: (TaskOut | null);
512
+ };
513
+
514
+ /**
515
+ * Enumerating the status of tasks
516
+ */
517
+ declare enum TaskStatus {
518
+ ASSIGNED = "ASSIGNED",
519
+ SKIPPED = "SKIPPED",
520
+ USER_DISCARDED = "USER_DISCARDED",
521
+ DISCARDED = "DISCARDED",
522
+ IN_REVIEW = "IN_REVIEW",
523
+ SUBMITTED = "SUBMITTED",
524
+ TO_FIX = "TO_FIX",
525
+ ACCEPTED = "ACCEPTED"
526
+ }
527
+
528
+ /**
529
+ * Type of task
530
+ */
531
+ declare enum TaskType {
532
+ ANNOTATION = "ANNOTATION",
533
+ QUESTIONNAIRE = "QUESTIONNAIRE"
534
+ }
535
+
536
+ type TimeseriesElement = {
537
+ name: string;
538
+ assets: Array<AssetElement>;
539
+ reference_dates: Array<string>;
540
+ };
541
+
542
+ type TimeseriesInfoResponse = {
543
+ types: Array<TimeseriesElement>;
544
+ };
545
+
546
+ type UpdateTaskRequest = {
547
+ task_id: number;
548
+ project_id: number;
549
+ target_status: string;
550
+ task_type: Array<TaskType>;
551
+ base64_array?: (string | null);
552
+ array_width?: (number | null);
553
+ array_height?: (number | null);
554
+ annotation_time?: (number | null);
555
+ annotation_dates?: (Array<string> | null);
556
+ comment?: (string | null);
557
+ questionnaire?: (Array<any[]> | null);
558
+ };
559
+
560
+ type UpdateTaskResponse = {
561
+ success: boolean;
562
+ message: (string | null);
563
+ updated_task: TaskOut;
564
+ };
565
+
566
+ type UserOut = {
567
+ user_id: string;
568
+ user_alias: string;
569
+ contract_start_date: (string | null);
570
+ contract_end_date: (string | null);
571
+ };
572
+
573
+ type UserProjectElement = {
574
+ project_id: number;
575
+ project_name: string;
576
+ project_reference_date: number;
577
+ project_type: string;
578
+ mixed_labels_level: number;
579
+ minimum_annotation: number;
580
+ maximum_annotation: number;
581
+ start_date: string;
582
+ end_date: (string | null);
583
+ creation_date: string;
584
+ project_owner: string;
585
+ meta_data?: (Record<string, any> | null);
586
+ current_active_group: number;
587
+ is_deleted: boolean;
588
+ n_locations: number;
589
+ n_locations_group: number;
590
+ group_submitted_locations: number;
591
+ group_completed_locations: number;
592
+ proj_submitted_locations: number;
593
+ proj_completed_locations: number;
594
+ user_contributions: number;
595
+ user_labelled_locations: number;
596
+ user_tasks_in_review: number;
597
+ user_tasks_to_fix: number;
598
+ user_tasks_accepted: number;
599
+ user_discarded_tasks: number;
600
+ user_task_submitted: number;
601
+ project_tasks_in_review: number;
602
+ project_tasks_to_fix: number;
603
+ project_tasks_accepted: number;
604
+ };
605
+
606
+ type UserStatistic = {
607
+ user_id: string;
608
+ user_alias: string;
609
+ contract_start: (string | null);
610
+ contract_end: (string | null);
611
+ submitted_tasks: number;
612
+ in_review_tasks: number;
613
+ accepted_tasks: number;
614
+ skipped_tasks: number;
615
+ user_discarded_tasks: number;
616
+ discarded_tasks: number;
617
+ to_fix_tasks: number;
618
+ all_finished_tasks: number;
619
+ min_time: (number | null);
620
+ max_time: (number | null);
621
+ mean_time: (number | null);
622
+ };
623
+
624
+ type UserStatisticsResponse = {
625
+ start_date: string;
626
+ end_date: string;
627
+ project_id: number;
628
+ statistics: Array<UserStatistic>;
629
+ };
630
+
631
+ declare class AiService {
632
+ /**
633
+ * Performs an automatic annotation of a location based on provided inputs by user.
634
+ * @param requestBody
635
+ * @returns ActiveLearningResponse Successful Response
636
+ * @throws ApiError
637
+ */
638
+ static performActiveLearningActivelearningPost(requestBody: ActiveLearningRequest): CancelablePromise<ActiveLearningResponse>;
639
+ }
640
+
641
+ declare class LocationService {
642
+ /**
643
+ * 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
644
+ * @param lon
645
+ * @param lat
646
+ * @param width
647
+ * @param height
648
+ * @returns PolygonResponse Successful Response
649
+ * @throws ApiError
650
+ */
651
+ static getPolygonUtmlocationLonLonLatLatWidthWidthHeightHeightGet(lon: number, lat: number, width: number, height: number): CancelablePromise<PolygonResponse>;
652
+ /**
653
+ * 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.
654
+ * @param requestBody
655
+ * @returns TaskResponse Successful Response
656
+ * @throws ApiError
657
+ */
658
+ static getLocationGetlocationPost(requestBody: GetLocationRequest): CancelablePromise<TaskResponse>;
659
+ /**
660
+ * Get the composite assets of a specific type from a location. Cannot get submitted annotations.
661
+ * @param requestBody
662
+ * @returns LocationAssetsResponse Successful Response
663
+ * @throws ApiError
664
+ */
665
+ static getLocationAssetsLocationtypeassetsPost(requestBody: GetAssetsRequest): CancelablePromise<LocationAssetsResponse>;
666
+ /**
667
+ * Get all the assets for a given location.
668
+ * @param requestBody
669
+ * @returns LocationAssetsResponse Successful Response
670
+ * @throws ApiError
671
+ */
672
+ static getAllAssetsLocationassetsPost(requestBody: GetLocationRequest): CancelablePromise<LocationAssetsResponse>;
673
+ /**
674
+ * Get a summary of the time series informations for a specific location.
675
+ * @param projectId
676
+ * @param locationId
677
+ * @returns TimeseriesInfoResponse Successful Response
678
+ * @throws ApiError
679
+ */
680
+ static timeseriesInfoTimeseriesassetsProjectIdProjectIdLocationIdLocationIdGet(projectId: number, locationId: string): CancelablePromise<TimeseriesInfoResponse>;
681
+ /**
682
+ * 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.
683
+ * @param requestBody
684
+ * @returns LocationCreatedResponse Successful Response
685
+ * @throws ApiError
686
+ */
687
+ static createLocationCreatelocationPost(requestBody: CreateLocationRequest): CancelablePromise<LocationCreatedResponse>;
688
+ /**
689
+ * Process annotation bytes into tiff
690
+ * @param requestBody
691
+ * @returns any Successful Response
692
+ * @throws ApiError
693
+ */
694
+ static processAnnotationProcessannotationPost(requestBody: AnnotationRequest): CancelablePromise<any>;
695
+ /**
696
+ * Process byte data into tiff
697
+ * @param requestBody
698
+ * @returns any Successful Response
699
+ * @throws ApiError
700
+ */
701
+ static processRasterProcessrasterPost(requestBody: RasterRequest): CancelablePromise<any>;
702
+ /**
703
+ * Accepts a geojson, validates rows, insert in location_task_mapping and returns a json for each row's status
704
+ * @param formData
705
+ * @returns any Successful Response
706
+ * @throws ApiError
707
+ */
708
+ static uploadLocationTaskUploadlocationtaskPost(formData: Body_upload_location_task_uploadlocationtask__post): CancelablePromise<Record<string, any>>;
709
+ /**
710
+ * Bulk Upload Locations
711
+ * Accepts a parquet file, validates rows and insert in locations table, returns status of inserted and error row
712
+ * @param formData
713
+ * @returns any Successful Response
714
+ * @throws ApiError
715
+ */
716
+ static bulkUploadLocationsUploadlocationsPost(formData: Body_bulk_upload_locations_uploadlocations__post): CancelablePromise<Record<string, any>>;
717
+ /**
718
+ * Bulk Upload Review Tasks
719
+ * Upload tasks which has been selected for review
720
+ * @param formData
721
+ * @returns any Successful Response
722
+ * @throws ApiError
723
+ */
724
+ static bulkUploadReviewTasksUploadreviewtasksPost(formData: Body_bulk_upload_review_tasks_uploadreviewtasks_post): CancelablePromise<Record<string, any>>;
725
+ }
726
+
727
+ declare class ProjectService {
728
+ /**
729
+ * Read Root
730
+ * @returns AboutResponse Successful Response
731
+ * @throws ApiError
732
+ */
733
+ static readRootGet(): CancelablePromise<AboutResponse>;
734
+ /**
735
+ * Get personal information by decoding the user token (specified inside the Authorization header field).
736
+ * @returns any Successful Response
737
+ * @throws ApiError
738
+ */
739
+ static getUserMeGet(): CancelablePromise<any>;
740
+ /**
741
+ * Returns the available layers from the WMS service.
742
+ * @returns LayersResponse Successful Response
743
+ * @throws ApiError
744
+ */
745
+ static getAvailableLayersAvailablelayersGet(): CancelablePromise<LayersResponse>;
746
+ /**
747
+ * Return the WC labels codes for a project, with their names and colors.
748
+ * @param projectId
749
+ * @returns LabelsResponse Successful Response
750
+ * @throws ApiError
751
+ */
752
+ static getLabelsLabelsProjectIdProjectIdGet(projectId: number): CancelablePromise<LabelsResponse>;
753
+ /**
754
+ * Return the combinatory (primary/secondary/tertiary) label codes, with their names and colors.
755
+ * @param projectId
756
+ * @returns LabelsResponse Successful Response
757
+ * @throws ApiError
758
+ */
759
+ static getCombinationLabelsCombinationlabelsProjectIdProjectIdGet(projectId: number): CancelablePromise<LabelsResponse>;
760
+ /**
761
+ * Get the project information from a specific project.
762
+ * @param projectId
763
+ * @returns ProjectDetailElement Successful Response
764
+ * @throws ApiError
765
+ */
766
+ static projectDetailProjectdetailProjectIdProjectIdGet(projectId: number): CancelablePromise<ProjectDetailElement>;
767
+ /**
768
+ * Get the project information, user statistics from a specific project.
769
+ * @param projectId
770
+ * @returns UserProjectElement Successful Response
771
+ * @throws ApiError
772
+ */
773
+ static projectInfoProjectinfoProjectIdProjectIdGet(projectId: number): CancelablePromise<UserProjectElement>;
774
+ /**
775
+ * 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.
776
+ * @param startidx
777
+ * @param amount
778
+ * @returns ListProjectResponse Successful Response
779
+ * @throws ApiError
780
+ */
781
+ static listProjectsListprojectsStartidxStartidxAmountAmountGet(startidx: number, amount: number): CancelablePromise<ListProjectResponse>;
782
+ /**
783
+ * Creates a project, adding the curent user as owner. Only GeoWiki admins can create a new project.
784
+ * @param requestBody
785
+ * @returns CreateProjectResponse Successful Response
786
+ * @throws ApiError
787
+ */
788
+ static createProjectCreateprojectPost(requestBody: CreateProjectRequest): CancelablePromise<CreateProjectResponse>;
789
+ /**
790
+ * Get the project result set information for all the location and tasks linked to a project
791
+ * @param projectId
792
+ * @param isGeoJson
793
+ * @returns any Successful Response
794
+ * @throws ApiError
795
+ */
796
+ static projectResultSetProjectresultsetProjectIdProjectIdIsGeoJsonIsGeoJsonGet(projectId: number, isGeoJson: boolean): CancelablePromise<any>;
797
+ /**
798
+ * Create a new user in the database. Only admins can create a new user.
799
+ * @param requestBody
800
+ * @returns GenericResponse Successful Response
801
+ * @throws ApiError
802
+ */
803
+ static createUserCreateuserPost(requestBody: CreateUserRequest): CancelablePromise<GenericResponse>;
804
+ /**
805
+ * Sets the user role in a project. If the user does not exists, then adds it to the project with the target role.
806
+ * @param requestBody
807
+ * @returns GenericResponse Successful Response
808
+ * @throws ApiError
809
+ */
810
+ static setUserRoleSetuserrolePost(requestBody: Array<SetUserRoleRequest>): CancelablePromise<GenericResponse>;
811
+ /**
812
+ * Sets the user role in a project. If the user does not exists, then adds it to the project with the target role.
813
+ * @param requestBody
814
+ * @returns GenericResponse Successful Response
815
+ * @throws ApiError
816
+ */
817
+ static setUserDetailSetuserdetailPost(requestBody: SetUserDetailRequest): CancelablePromise<GenericResponse>;
818
+ /**
819
+ * Get user role and project
820
+ * @param userId
821
+ * @returns GetUserRoleProjectResponse Successful Response
822
+ * @throws ApiError
823
+ */
824
+ static getUserRoleProjectGetuserroleprojectUserIdUserIdGet(userId: string): CancelablePromise<Array<GetUserRoleProjectResponse>>;
825
+ /**
826
+ * Removes an user from a project.
827
+ * @param requestBody
828
+ * @returns GenericResponse Successful Response
829
+ * @throws ApiError
830
+ */
831
+ static removeUserRemoveuserPost(requestBody: RemoveUserRequest): CancelablePromise<GenericResponse>;
832
+ /**
833
+ * Returns a set of locations, or a sets of clusters given a bounding box
834
+ * @param requestBody
835
+ * @returns ListLocationsResponse Successful Response
836
+ * @throws ApiError
837
+ */
838
+ static searchLocationsLocationsPost(requestBody: ListLocationsRequest): CancelablePromise<ListLocationsResponse>;
839
+ /**
840
+ * Returns a summary of locations,groups
841
+ * @param projectId
842
+ * @returns any Successful Response
843
+ * @throws ApiError
844
+ */
845
+ static getLocationsSummaryLocationssummaryProjectIdProjectIdGet(projectId: number): CancelablePromise<any>;
846
+ /**
847
+ * Get the table of tasks of the user if an user is specified.
848
+ * @param locationProjectId
849
+ * @param taskForReview
850
+ * @param id
851
+ * @param orderBy
852
+ * @param search
853
+ * @param status
854
+ * @param statusIn
855
+ * @param dateLte
856
+ * @param dateGte
857
+ * @param pageIdx
858
+ * @param pageSize
859
+ * @param userId
860
+ * @param userUserAlias
861
+ * @param userOrderBy
862
+ * @param locationLocationId
863
+ * @param locationOrderBy
864
+ * @param groupName
865
+ * @param groupOrderBy
866
+ * @returns TaskFilterResponse Successful Response
867
+ * @throws ApiError
868
+ */
869
+ 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>;
870
+ /**
871
+ * Get a random task for the user, based on the same filter available in the GET /tasks call.
872
+ * @param locationProjectId
873
+ * @param taskForReview
874
+ * @param id
875
+ * @param orderBy
876
+ * @param search
877
+ * @param status
878
+ * @param statusIn
879
+ * @param dateLte
880
+ * @param dateGte
881
+ * @param pageIdx
882
+ * @param pageSize
883
+ * @param userId
884
+ * @param userUserAlias
885
+ * @param userOrderBy
886
+ * @param locationLocationId
887
+ * @param locationOrderBy
888
+ * @param groupName
889
+ * @param groupOrderBy
890
+ * @returns TaskResponse Successful Response
891
+ * @throws ApiError
892
+ */
893
+ 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>;
894
+ /**
895
+ * Returns a list of groups available within a project.
896
+ * @param projectId
897
+ * @returns ProjectGroupResponse Successful Response
898
+ * @throws ApiError
899
+ */
900
+ static getProjectGroupsProjectgroupsProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<ProjectGroupResponse>>;
901
+ /**
902
+ * Selects an active group for a project.
903
+ * @param requestBody
904
+ * @returns GenericResponse Successful Response
905
+ * @throws ApiError
906
+ */
907
+ static selectProjectGroupProjectselectgroupPost(requestBody: SelectGroupRequest): CancelablePromise<GenericResponse>;
908
+ /**
909
+ * List all the users within a project.
910
+ * @param projectId
911
+ * @returns UserOut Successful Response
912
+ * @throws ApiError
913
+ */
914
+ static projectAllUsersProjectusersProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<UserOut>>;
915
+ /**
916
+ * Returns the task information for a specific location. The task returned is the task with the latest update.
917
+ * @param locationId
918
+ * @param projectId
919
+ * @param referenceDate
920
+ * @returns LocationTaskAnnotationResponse Successful Response
921
+ * @throws ApiError
922
+ */
923
+ static locationLatestTaskLocationtaskLocationIdLocationIdProjectIdProjectIdReferenceDateReferenceDateGet(locationId: string, projectId: number, referenceDate: string): CancelablePromise<LocationTaskAnnotationResponse>;
924
+ }
925
+
926
+ declare class QuestionService {
927
+ /**
928
+ * Get Project Questions Answers
929
+ * get pairs of questions and answers associated with a project
930
+ * @param projectId
931
+ * @returns Questionnaire Successful Response
932
+ * @throws ApiError
933
+ */
934
+ static getProjectQuestionsAnswersQuestionsAnswersProjectIdProjectIdGet(projectId: number): CancelablePromise<Array<Questionnaire>>;
935
+ }
936
+
937
+ declare class StatisticService {
938
+ /**
939
+ * Get User Statistics
940
+ * For each user within a project, get statistics related to the tasks that were updated.
941
+ * @param projectId
942
+ * @param endDate
943
+ * @param startDate
944
+ * @param isContractualData
945
+ * @param filterUserId
946
+ * @returns UserStatisticsResponse Successful Response
947
+ * @throws ApiError
948
+ */
949
+ static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateFilterUserIdFilterUserIdIsContractualDataIsContractualDataGet(projectId: number, endDate: string, startDate: (string | null), isContractualData: boolean, filterUserId: (string | null)): CancelablePromise<UserStatisticsResponse>;
950
+ /**
951
+ * Get User Statistics
952
+ * For each user within a project, get statistics related to the tasks that were updated.
953
+ * @param projectId
954
+ * @param endDate
955
+ * @param startDate
956
+ * @param filterUserId
957
+ * @param isContractualData
958
+ * @returns UserStatisticsResponse Successful Response
959
+ * @throws ApiError
960
+ */
961
+ static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateFilterUserIdFilterUserIdGet(projectId: number, endDate: string, startDate: (string | null), filterUserId: (string | null), isContractualData?: boolean): CancelablePromise<UserStatisticsResponse>;
962
+ /**
963
+ * Get User Statistics
964
+ * For each user within a project, get statistics related to the tasks that were updated.
965
+ * @param projectId
966
+ * @param endDate
967
+ * @param startDate
968
+ * @param isContractualData
969
+ * @param filterUserId
970
+ * @returns UserStatisticsResponse Successful Response
971
+ * @throws ApiError
972
+ */
973
+ static getUserStatisticsUserstatisticsProjectIdProjectIdStartDateStartDateEndDateEndDateGet(projectId: number, endDate: string, startDate: (string | null), isContractualData?: boolean, filterUserId?: (string | null)): CancelablePromise<UserStatisticsResponse>;
974
+ }
975
+
976
+ declare class TaskService {
977
+ /**
978
+ * Get all the possible task statuses
979
+ * @returns string Successful Response
980
+ * @throws ApiError
981
+ */
982
+ static getTaskStatusesTaskstatusesGet(): CancelablePromise<Array<string>>;
983
+ /**
984
+ * Get the task information for a specific task id.
985
+ * @param taskId
986
+ * @returns TaskResponse Successful Response
987
+ * @throws ApiError
988
+ */
989
+ static getTaskGettaskTaskIdTaskIdGet(taskId: number): CancelablePromise<TaskResponse>;
990
+ /**
991
+ * 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.
992
+ * @param requestBody
993
+ * @returns TaskResponse Successful Response
994
+ * @throws ApiError
995
+ */
996
+ static createTaskCreatetaskPost(requestBody: CreateTaskRequest): CancelablePromise<TaskResponse>;
997
+ /**
998
+ * 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.
999
+ * @param requestBody
1000
+ * @returns TaskResponse Successful Response
1001
+ * @throws ApiError
1002
+ */
1003
+ static getNextLocationNexttaskPost(requestBody: NextTaskRequest): CancelablePromise<TaskResponse>;
1004
+ /**
1005
+ * 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.
1006
+ * @param requestBody
1007
+ * @returns GenericResponse Successful Response
1008
+ * @throws ApiError
1009
+ */
1010
+ static deleteTaskDeletetaskPost(requestBody: DeleteTaskRequest): CancelablePromise<GenericResponse>;
1011
+ /**
1012
+ * Get the latest task annotation for a specific task id.
1013
+ * @param taskId
1014
+ * @returns TaskAnnotationResponse Successful Response
1015
+ * @throws ApiError
1016
+ */
1017
+ static getTaskAnnotationAssetTaskannotationTaskIdTaskIdGet(taskId: number): CancelablePromise<TaskAnnotationResponse>;
1018
+ /**
1019
+ * Get all the annotations for a specific task id.
1020
+ * @param taskId
1021
+ * @returns LocationAssetsResponse Successful Response
1022
+ * @throws ApiError
1023
+ */
1024
+ static getTaskAnnotationAssetsTaskannotationsTaskIdTaskIdGet(taskId: number): CancelablePromise<LocationAssetsResponse>;
1025
+ /**
1026
+ * Saves an annotation for a task.
1027
+ * @param requestBody
1028
+ * @returns GenericResponse Successful Response
1029
+ * @throws ApiError
1030
+ */
1031
+ static saveAnnotationSaveannotationPost(requestBody: SaveAnnotationRequest): CancelablePromise<GenericResponse>;
1032
+ /**
1033
+ * Get the saved annotation for a specific task (if it exists).
1034
+ * @param taskId
1035
+ * @returns GetSavedAnnotationResponse Successful Response
1036
+ * @throws ApiError
1037
+ */
1038
+ static getSavedAnnotationGetsavedannotationTaskIdTaskIdGet(taskId: number): CancelablePromise<GetSavedAnnotationResponse>;
1039
+ /**
1040
+ * Save Questionnaire
1041
+ * Save questionnaire for a task
1042
+ * @param requestBody
1043
+ * @returns GenericResponse Successful Response
1044
+ * @throws ApiError
1045
+ */
1046
+ static saveQuestionnaireSavequestionnairePost(requestBody: SaveQuestionnaireRequest): CancelablePromise<GenericResponse>;
1047
+ /**
1048
+ * Get change detection details associated with a task
1049
+ * @param taskId
1050
+ * @returns TaskChangeElement Successful Response
1051
+ * @throws ApiError
1052
+ */
1053
+ static getTaskChangeDetailTaskchangedetailsPost(taskId: number): CancelablePromise<TaskChangeElement>;
1054
+ /**
1055
+ * Get change detection details associated with a task
1056
+ * @param taskId
1057
+ * @returns TaskGeometryElement Successful Response
1058
+ * @throws ApiError
1059
+ */
1060
+ static getTaskGeometryDetailTaskgeometryetailsPost(taskId: number): CancelablePromise<TaskGeometryElement>;
1061
+ /**
1062
+ * 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
1063
+ * @param requestBody
1064
+ * @returns UpdateTaskResponse Successful Response
1065
+ * @throws ApiError
1066
+ */
1067
+ static updateTaskUpdatetaskPost(requestBody: UpdateTaskRequest): CancelablePromise<UpdateTaskResponse>;
1068
+ /**
1069
+ * Adds a comment from an user on a task.
1070
+ * @param requestBody
1071
+ * @returns GenericResponse Successful Response
1072
+ * @throws ApiError
1073
+ */
1074
+ static taskCommentTaskcommentPost(requestBody: TaskCommentRequest): CancelablePromise<GenericResponse>;
1075
+ /**
1076
+ * Get the events of a task.
1077
+ * @param taskId
1078
+ * @returns TaskEventOut Successful Response
1079
+ * @throws ApiError
1080
+ */
1081
+ static getTaskEventsTaskeventsTaskIdTaskIdGet(taskId: number): CancelablePromise<Array<TaskEventOut>>;
1082
+ /**
1083
+ * 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.
1084
+ * @param requestBody
1085
+ * @returns TaskLatestCommentResponse Successful Response
1086
+ * @throws ApiError
1087
+ */
1088
+ static taskLatestComomentsTasklatestcommentPost(requestBody: TaskLatestCommentRequest): CancelablePromise<TaskLatestCommentResponse>;
1089
+ /**
1090
+ * Get the reference dates for current task on a location from meta_data.The response model will be a list of string
1091
+ * @param locationId
1092
+ * @param projectId
1093
+ * @param assetType
1094
+ * @returns any Successful Response
1095
+ * @throws ApiError
1096
+ */
1097
+ static taskReferenceDatesGettaskreferencedatesProjectIdProjectIdLocationIdLocationIdAssetTypeAssetTypeGet(locationId: string, projectId: number, assetType: string): CancelablePromise<(Array<string> | null)>;
1098
+ /**
1099
+ * returns a list of user provided answers associated with a task
1100
+ * @param taskId
1101
+ * @returns any[] Successful Response
1102
+ * @throws ApiError
1103
+ */
1104
+ static getTaskAnswersTaskanswersTaskIdTaskIdGet(taskId: number): CancelablePromise<Array<any[]>>;
1105
+ }
1106
+
1107
+ 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 };