reportnet-api 0.1.0__py3-none-any.whl

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,555 @@
1
+ # Generated from spec/api-docs.json by scripts/regen_models.sh — do not edit by hand.
2
+
3
+ from __future__ import annotations
4
+
5
+ from enum import StrEnum
6
+ from typing import Any
7
+
8
+ from pydantic import AwareDatetime, Base64Str, BaseModel, Field
9
+
10
+
11
+ class CheckLockVO(BaseModel):
12
+ importInProgress: bool | None = None
13
+ message: str | None = None
14
+
15
+
16
+ class CreateSnapshotVO(BaseModel):
17
+ automatic: bool | None = None
18
+ description: str | None = None
19
+ released: bool | None = None
20
+
21
+
22
+ class DatasetRunningStatus(StrEnum):
23
+ IN_QUEUE = "IN_QUEUE"
24
+ ERROR_IN_VALIDATION = "ERROR_IN_VALIDATION"
25
+ ERROR_IN_IMPORT = "ERROR_IN_IMPORT"
26
+ IMPORTING = "IMPORTING"
27
+ IMPORTED = "IMPORTED"
28
+ VALIDATING = "VALIDATING"
29
+ VALIDATED = "VALIDATED"
30
+ RESTORING_SNAPSHOT = "RESTORING_SNAPSHOT"
31
+
32
+
33
+ class DatasetTypeEnum(StrEnum):
34
+ REPORTING = "REPORTING"
35
+ DESIGN = "DESIGN"
36
+ COLLECTION = "COLLECTION"
37
+ TEST = "TEST"
38
+ EUDATASET = "EUDATASET"
39
+ REFERENCE = "REFERENCE"
40
+
41
+
42
+ class Status(StrEnum):
43
+ FINAL_FEEDBACK = "FINAL_FEEDBACK"
44
+ TECHNICALLY_ACCEPTED = "TECHNICALLY_ACCEPTED"
45
+ PENDING = "PENDING"
46
+ CORRECTION_REQUESTED = "CORRECTION_REQUESTED"
47
+ RELEASED = "RELEASED"
48
+ MULTIPLE = "MULTIPLE"
49
+
50
+
51
+ class DataSetMetabaseVO(BaseModel):
52
+ creationDate: AwareDatetime | None = None
53
+ dataProviderId: int | None = None
54
+ dataSetName: str | None = None
55
+ dataflowId: int | None = None
56
+ datasetRunningStatus: DatasetRunningStatus | None = None
57
+ datasetSchema: str | None = None
58
+ datasetTypeEnum: DatasetTypeEnum | None = None
59
+ id: int | None = None
60
+ status: Status | None = None
61
+
62
+
63
+ class LevelError(StrEnum):
64
+ CORRECT = "CORRECT"
65
+ WARNING = "WARNING"
66
+ ERROR = "ERROR"
67
+ INFO = "INFO"
68
+ BLOCKER = "BLOCKER"
69
+
70
+
71
+ class DatasetEditingStatusVO(BaseModel):
72
+ datasetId: int | None = None
73
+ editor: str | None = None
74
+ isEditing: bool | None = None
75
+ isLockedForUser: bool | None = None
76
+
77
+
78
+ class DatasetTableVO(BaseModel):
79
+ datasetId: int | None = None
80
+ datasetSchemaId: str | None = None
81
+ id: int | None = None
82
+ isIcebergTableCreated: bool | None = None
83
+ tableName: str | None = None
84
+ tableSchemaId: str | None = None
85
+
86
+
87
+ class ETLFieldVO(BaseModel):
88
+ fieldName: str | None = None
89
+ value: str | None = None
90
+
91
+
92
+ class ETLRecordVO(BaseModel):
93
+ countryCode: str | None = None
94
+ fields: list[ETLFieldVO] | None = None
95
+
96
+
97
+ class ETLTableVO(BaseModel):
98
+ records: list[ETLRecordVO] | None = None
99
+ tableName: str | None = None
100
+
101
+
102
+ class EUDatasetVO(BaseModel):
103
+ creationDate: AwareDatetime | None = None
104
+ dataSetName: str | None = None
105
+ datasetSchema: str | None = None
106
+ id: int | None = None
107
+ idDataflow: int | None = None
108
+ status: str | None = None
109
+
110
+
111
+ class LevelErrorEnum(StrEnum):
112
+ CORRECT = "CORRECT"
113
+ WARNING = "WARNING"
114
+ ERROR = "ERROR"
115
+ INFO = "INFO"
116
+ BLOCKER = "BLOCKER"
117
+
118
+
119
+ class ExportFilterVO(BaseModel):
120
+ fieldValue: str | None = None
121
+ idRules: str | None = None
122
+ levelError: list[LevelErrorEnum] | None = None
123
+ qcCodes: str | None = None
124
+
125
+
126
+ class Type(StrEnum):
127
+ TEXT = "TEXT"
128
+ TEXTAREA = "TEXTAREA"
129
+ LONG_TEXT = "LONG_TEXT"
130
+ NUMBER_INTEGER = "NUMBER_INTEGER"
131
+ NUMBER_DECIMAL = "NUMBER_DECIMAL"
132
+ DATE = "DATE"
133
+ DATETIME = "DATETIME"
134
+ BOOLEAN = "BOOLEAN"
135
+ POINT = "POINT"
136
+ LINESTRING = "LINESTRING"
137
+ POLYGON = "POLYGON"
138
+ MULTIPOINT = "MULTIPOINT"
139
+ MULTILINESTRING = "MULTILINESTRING"
140
+ MULTIPOLYGON = "MULTIPOLYGON"
141
+ GEOMETRYCOLLECTION = "GEOMETRYCOLLECTION"
142
+ CODELIST = "CODELIST"
143
+ MULTISELECT_CODELIST = "MULTISELECT_CODELIST"
144
+ LINK = "LINK"
145
+ EXTERNAL_LINK = "EXTERNAL_LINK"
146
+ URL = "URL"
147
+ PHONE = "PHONE"
148
+ EMAIL = "EMAIL"
149
+ ATTACHMENT = "ATTACHMENT"
150
+
151
+
152
+ class File(BaseModel):
153
+ absolute: bool | None = None
154
+ absoluteFile: File | None = None
155
+ absolutePath: str | None = None
156
+ canonicalFile: File | None = None
157
+ canonicalPath: str | None = None
158
+ directory: bool | None = None
159
+ file: bool | None = None
160
+ freeSpace: int | None = None
161
+ hidden: bool | None = None
162
+ name: str | None = None
163
+ parent: str | None = None
164
+ parentFile: File | None = None
165
+ path: str | None = None
166
+ totalSpace: int | None = None
167
+ usableSpace: int | None = None
168
+
169
+
170
+ class ImportStatisticsVO(BaseModel):
171
+ fileExtension: str | None = None
172
+ lastImportDate: AwareDatetime | None = None
173
+ numberOfRecordsImported: int | None = None
174
+
175
+
176
+ class ImportedFilesDirectoriesVO(BaseModel):
177
+ creationDate: str | None = None
178
+ creationDateTimestamp: int | None = None
179
+ fileName: str | None = None
180
+ fileSize: str | None = None
181
+ lastModifiedTime: int | None = None
182
+
183
+
184
+ class InputStream(BaseModel):
185
+ pass
186
+
187
+
188
+ class JobPresignedUrlInfo(BaseModel):
189
+ filePathInS3: str | None = None
190
+ jobId: int | None = None
191
+ presignedUrl: str | None = None
192
+
193
+
194
+ class LockType(StrEnum):
195
+ METHOD = "METHOD"
196
+ ENTITY = "ENTITY"
197
+
198
+
199
+ class OrderVO(BaseModel):
200
+ id: str | None = None
201
+ position: int | None = None
202
+
203
+
204
+ class ReferencedFieldSchemaVO(BaseModel):
205
+ dataflowId: int | None = None
206
+ fieldSchemaName: str | None = None
207
+ idDatasetSchema: str | None = None
208
+ idPk: str | None = None
209
+ labelId: str | None = None
210
+ linkedConditionalFieldId: str | None = None
211
+ masterConditionalFieldId: str | None = None
212
+ tableSchemaName: str | None = None
213
+
214
+
215
+ class ReleaseReceiptVO(BaseModel):
216
+ dataflowId: int | None = None
217
+ id: int | None = None
218
+ note: str | None = None
219
+
220
+
221
+ class ReleaseVO(BaseModel):
222
+ dataProviderCode: str | None = None
223
+ dataProviderId: int | None = None
224
+ datasetId: int | None = None
225
+ datasetName: str | None = None
226
+ dateReleased: AwareDatetime | None = None
227
+ dcrelease: bool | None = None
228
+ eurelease: bool | None = None
229
+ id: int | None = None
230
+ restrictFromPublic: bool | None = None
231
+
232
+
233
+ class ReleasedDatasetDataInfoVO(BaseModel):
234
+ collectionDatasetNumberOfRecords: int | None = None
235
+ hasReleased: bool | None = None
236
+ modifiedAfterRelease: bool | None = None
237
+ reportingDatasetNumberOfRecords: int | None = None
238
+
239
+
240
+ class FieldType(StrEnum):
241
+ TEXT = "TEXT"
242
+ TEXTAREA = "TEXTAREA"
243
+ LONG_TEXT = "LONG_TEXT"
244
+ NUMBER_INTEGER = "NUMBER_INTEGER"
245
+ NUMBER_DECIMAL = "NUMBER_DECIMAL"
246
+ DATE = "DATE"
247
+ DATETIME = "DATETIME"
248
+ BOOLEAN = "BOOLEAN"
249
+ POINT = "POINT"
250
+ LINESTRING = "LINESTRING"
251
+ POLYGON = "POLYGON"
252
+ MULTIPOINT = "MULTIPOINT"
253
+ MULTILINESTRING = "MULTILINESTRING"
254
+ MULTIPOLYGON = "MULTIPOLYGON"
255
+ GEOMETRYCOLLECTION = "GEOMETRYCOLLECTION"
256
+ CODELIST = "CODELIST"
257
+ MULTISELECT_CODELIST = "MULTISELECT_CODELIST"
258
+ LINK = "LINK"
259
+ EXTERNAL_LINK = "EXTERNAL_LINK"
260
+ URL = "URL"
261
+ PHONE = "PHONE"
262
+ EMAIL = "EMAIL"
263
+ ATTACHMENT = "ATTACHMENT"
264
+
265
+
266
+ class SimpleFieldSchemaVO(BaseModel):
267
+ fieldName: str | None = None
268
+ fieldType: FieldType | None = None
269
+
270
+
271
+ class SimpleTableSchemaVO(BaseModel):
272
+ fields: list[SimpleFieldSchemaVO] | None = None
273
+ tableName: str | None = None
274
+
275
+
276
+ class SnapshotVO(BaseModel):
277
+ automatic: bool | None = None
278
+ creationDate: AwareDatetime | None = None
279
+ datasetId: int | None = None
280
+ dateReleased: AwareDatetime | None = None
281
+ description: str | None = None
282
+ enabled: bool | None = None
283
+ id: int | None = None
284
+ release: bool | None = None
285
+
286
+
287
+ class StreamingResponseBody(BaseModel):
288
+ pass
289
+
290
+
291
+ class TableSchemaIdNameVO(BaseModel):
292
+ idTableSchema: str | None = None
293
+ nameTableSchema: str | None = None
294
+
295
+
296
+ class Status1(StrEnum):
297
+ IN_QUEUE = "IN_QUEUE"
298
+ IN_PROGRESS = "IN_PROGRESS"
299
+ CANCELED = "CANCELED"
300
+ FINISHED = "FINISHED"
301
+
302
+
303
+ class TaskType(StrEnum):
304
+ VALIDATION_TASK = "VALIDATION_TASK"
305
+ IMPORT_TASK = "IMPORT_TASK"
306
+ RELEASE_TASK = "RELEASE_TASK"
307
+ COPY_TO_EU_DATASET_TASK = "COPY_TO_EU_DATASET_TASK"
308
+ RESTORE_REPORTING_DATASET_TASK = "RESTORE_REPORTING_DATASET_TASK"
309
+ RESTORE_DESIGN_DATASET_TASK = "RESTORE_DESIGN_DATASET_TASK"
310
+ COPY_REFERENCE_DATASET_TASK = "COPY_REFERENCE_DATASET_TASK"
311
+
312
+
313
+ class TaskVO(BaseModel):
314
+ createDate: AwareDatetime | None = None
315
+ finishDate: AwareDatetime | None = None
316
+ id: int | None = None
317
+ json_: str | None = Field(None, alias="json")
318
+ pod: str | None = None
319
+ processId: str | None = None
320
+ startingDate: AwareDatetime | None = None
321
+ status: Status1 | None = None
322
+ taskType: TaskType | None = None
323
+ version: int | None = None
324
+
325
+
326
+ class Timestamp(BaseModel):
327
+ date: int | None = None
328
+ day: int | None = None
329
+ hours: int | None = None
330
+ minutes: int | None = None
331
+ month: int | None = None
332
+ nanos: int | None = None
333
+ seconds: int | None = None
334
+ time: int | None = None
335
+ timezoneOffset: int | None = None
336
+ year: int | None = None
337
+
338
+
339
+ class TruncateDataset(BaseModel):
340
+ dataProviderId: int | None = None
341
+ dataflowId: int | None = None
342
+ dataflowName: str | None = None
343
+ datasetId: int | None = None
344
+ datasetName: str | None = None
345
+
346
+
347
+ class URI(BaseModel):
348
+ absolute: bool | None = None
349
+ authority: str | None = None
350
+ fragment: str | None = None
351
+ host: str | None = None
352
+ opaque: bool | None = None
353
+ path: str | None = None
354
+ port: int | None = None
355
+ query: str | None = None
356
+ rawAuthority: str | None = None
357
+ rawFragment: str | None = None
358
+ rawPath: str | None = None
359
+ rawQuery: str | None = None
360
+ rawSchemeSpecificPart: str | None = None
361
+ rawUserInfo: str | None = None
362
+ scheme: str | None = None
363
+ schemeSpecificPart: str | None = None
364
+ userInfo: str | None = None
365
+
366
+
367
+ class URL(BaseModel):
368
+ authority: str | None = None
369
+ content: dict[str, Any] | None = None
370
+ defaultPort: int | None = None
371
+ file: str | None = None
372
+ host: str | None = None
373
+ path: str | None = None
374
+ port: int | None = None
375
+ protocol: str | None = None
376
+ query: str | None = None
377
+ ref: str | None = None
378
+ userInfo: str | None = None
379
+
380
+
381
+ class UniqueConstraintVO(BaseModel):
382
+ dataflowId: str | None = None
383
+ datasetSchemaId: str | None = None
384
+ fieldSchemaIds: list[str] | None = None
385
+ tableSchemaId: str | None = None
386
+ uniqueId: str | None = None
387
+
388
+
389
+ class TypeEntity(StrEnum):
390
+ TABLE = "TABLE"
391
+ DATASET = "DATASET"
392
+ FIELD = "FIELD"
393
+ RECORD = "RECORD"
394
+
395
+
396
+ class ValidationVO(BaseModel):
397
+ id: int | None = None
398
+ idRule: str | None = None
399
+ levelError: LevelError | None = None
400
+ message: str | None = None
401
+ typeEntity: TypeEntity | None = None
402
+ validationDate: str | None = None
403
+
404
+
405
+ class WebformVO(BaseModel):
406
+ name: str | None = None
407
+ type: str | None = None
408
+
409
+
410
+ class ETLDatasetVO(BaseModel):
411
+ tables: list[ETLTableVO] | None = None
412
+
413
+
414
+ class FieldSchemaVO(BaseModel):
415
+ codelistItems: list[str] | None = None
416
+ description: str | None = None
417
+ id: str | None = None
418
+ idRecord: str | None = None
419
+ ignoreCaseInLinks: bool | None = None
420
+ maxSize: float | None = None
421
+ name: str | None = None
422
+ pk: bool | None = None
423
+ pkHasMultipleValues: bool | None = None
424
+ pkMustBeUsed: bool | None = None
425
+ pkReferenced: bool | None = None
426
+ readOnly: bool | None = None
427
+ referencedField: ReferencedFieldSchemaVO | None = None
428
+ required: bool | None = None
429
+ type: Type | None = None
430
+ validExtensions: list[str] | None = None
431
+
432
+
433
+ class InputStreamResource(BaseModel):
434
+ description: str | None = None
435
+ file: File | None = None
436
+ filename: str | None = None
437
+ inputStream: InputStream | None = None
438
+ open: bool | None = None
439
+ readable: bool | None = None
440
+ uri: URI | None = None
441
+ url: URL | None = None
442
+
443
+
444
+ class LockVO(BaseModel):
445
+ createDate: Timestamp | None = None
446
+ createdBy: str | None = None
447
+ id: int | None = None
448
+ lockCriteria: dict[str, Any] | None = None
449
+ lockType: LockType | None = None
450
+
451
+
452
+ class RecordSchemaVO(BaseModel):
453
+ fieldSchema: list[FieldSchemaVO] | None = None
454
+ idRecordSchema: str | None = None
455
+
456
+
457
+ class SimpleDatasetSchemaVO(BaseModel):
458
+ datasetName: str | None = None
459
+ tables: list[SimpleTableSchemaVO] | None = None
460
+
461
+
462
+ class TableSchemaVO(BaseModel):
463
+ dataAreManuallyEditable: bool | None = None
464
+ description: str | None = None
465
+ fixedNumber: bool | None = None
466
+ idTableSchema: str | None = None
467
+ nameTableSchema: str | None = None
468
+ notEmpty: bool | None = None
469
+ readOnly: bool | None = None
470
+ recordSchema: RecordSchemaVO | None = None
471
+ toPrefill: bool | None = None
472
+
473
+
474
+ class DataSetSchemaVO(BaseModel):
475
+ availableInPublic: bool | None = None
476
+ description: str | None = None
477
+ idDataSetSchema: str | None = None
478
+ nameDatasetSchema: str | None = None
479
+ referenceDataset: bool | None = None
480
+ tableSchemas: list[TableSchemaVO] | None = None
481
+ webform: WebformVO | None = None
482
+
483
+
484
+ class DataSetVO(BaseModel):
485
+ datasetValidations: list[DatasetValidationVO] | None = None
486
+ id: int | None = None
487
+ idDatasetSchema: str | None = None
488
+ levelError: LevelError | None = None
489
+ tableVO: list[TableVO] | None = None
490
+
491
+
492
+ class DatasetValidationVO(BaseModel):
493
+ datasetValue: DataSetVO | None = None
494
+ id: int | None = None
495
+ validation: ValidationVO | None = None
496
+
497
+
498
+ class FieldVO(BaseModel):
499
+ autoIncrement: bool | None = None
500
+ byteArrayValue: Base64Str | None = None
501
+ fieldValidations: list[FieldValidationVO] | None = None
502
+ id: str | None = None
503
+ idFieldSchema: str | None = None
504
+ label: str | None = None
505
+ levelError: LevelError | None = None
506
+ name: str | None = None
507
+ referenceFieldSchemaId: str | None = None
508
+ type: Type | None = None
509
+ value: str | None = None
510
+
511
+
512
+ class FieldValidationVO(BaseModel):
513
+ fieldValue: FieldVO | None = None
514
+ id: int | None = None
515
+ validation: ValidationVO | None = None
516
+
517
+
518
+ class RecordVO(BaseModel):
519
+ dataProviderCode: str | None = None
520
+ datasetPartitionId: int | None = None
521
+ fields: list[FieldVO] | None = None
522
+ id: str | None = None
523
+ idRecordSchema: str | None = None
524
+ levelError: LevelError | None = None
525
+ recordValidations: list[RecordValidationVO] | None = None
526
+ sortCriteria: str | None = None
527
+
528
+
529
+ class RecordValidationVO(BaseModel):
530
+ id: int | None = None
531
+ recordValue: RecordVO | None = None
532
+ validation: ValidationVO | None = None
533
+
534
+
535
+ class TableVO(BaseModel):
536
+ id: int | None = None
537
+ idTableSchema: str | None = None
538
+ levelError: LevelError | None = None
539
+ records: list[RecordVO] | None = None
540
+ tableValidations: list[TableValidationVO] | None = None
541
+ totalFilteredRecords: int | None = None
542
+ totalRecords: int | None = None
543
+
544
+
545
+ class TableValidationVO(BaseModel):
546
+ id: int | None = None
547
+ tableValue: TableVO | None = None
548
+ validation: ValidationVO | None = None
549
+
550
+
551
+ File.model_rebuild()
552
+ DataSetVO.model_rebuild()
553
+ FieldVO.model_rebuild()
554
+ RecordVO.model_rebuild()
555
+ TableVO.model_rebuild()
reportnet_api/py.typed ADDED
File without changes
File without changes