@golemio/fypr 1.8.0-dev.2611358386 → 1.8.0-dev.2614520446

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs/openapi-output.yaml +450 -203
  2. package/package.json +1 -1
package/docs/openapi-output.yaml CHANGED
@@ -450,7 +450,251 @@ components:
450
450
  - error_status
451
451
 
452
452
  schemas:
453
+ ElementStateEnum:
454
+ type: string
455
+ nullable: true
456
+ enum:
457
+ - "Plánováno"
458
+ - "V přípravě"
459
+ - "Hotovo"
460
+ - "Zrušeno"
461
+ - "Neplánováno"
462
+ description: >-
463
+ State of the element (stav prvku). Common across all element kinds.
464
+
465
+ PhaseStateEnum:
466
+ type: string
467
+ nullable: true
468
+ enum:
469
+ - "Neobjednáno"
470
+ - "V přípravě"
471
+ - "Objednáno"
472
+ - "Probíhá"
473
+ - "Hotovo"
474
+ description: >-
475
+ State of a procurement phase (design, production, or realization).
476
+
477
+ InsuranceStateEnum:
478
+ type: string
479
+ nullable: true
480
+ enum:
481
+ - "V přípravě"
482
+ - "Objednáno"
483
+ - "Hotovo"
484
+ description: >-
485
+ State of the insurance policy for an element.
486
+
487
+ OrderStateEnum:
488
+ type: string
489
+ nullable: true
490
+ enum:
491
+ - "V přípravě"
492
+ - "Objednáno"
493
+ - "Hotovo"
494
+ description: >-
495
+ State of the procurement order for an element.
496
+
497
+ BuildingPermitStateEnum:
498
+ type: string
499
+ nullable: true
500
+ enum:
501
+ - "V plánu"
502
+ - "Probíhá"
503
+ - "Hotovo"
504
+ description: >-
505
+ State of the building permit process for an element.
506
+
507
+ YesNoPlanEnum:
508
+ type: string
509
+ nullable: true
510
+ enum:
511
+ - "ANO"
512
+ - "NE"
513
+ - "V PLÁNU"
514
+ description: >-
515
+ Three-state yes/no/planned indicator.
516
+
517
+ YesNoEnum:
518
+ type: string
519
+ nullable: true
520
+ enum:
521
+ - "ANO"
522
+ - "NE"
523
+ description: >-
524
+ Binary yes/no indicator.
525
+
526
+ CityDistrictEnum:
527
+ type: string
528
+ nullable: true
529
+ enum:
530
+ - "Praha 1"
531
+ - "Praha 2"
532
+ - "Praha 3"
533
+ - "Praha 4"
534
+ - "Praha 5"
535
+ - "Praha 6"
536
+ - "Praha 7"
537
+ - "Praha 8"
538
+ - "Praha 9"
539
+ - "Praha 10"
540
+ - "Praha 11"
541
+ - "Praha 12"
542
+ - "Praha 13"
543
+ - "Praha 14"
544
+ - "Praha 15"
545
+ - "Praha 16"
546
+ - "Praha 17"
547
+ - "Praha 18"
548
+ - "Praha 19"
549
+ - "Praha 20"
550
+ - "Praha 21"
551
+ - "Praha 22"
552
+ - "Praha-Běchovice"
553
+ - "Praha-Benice"
554
+ - "Praha-Březiněves"
555
+ - "Praha-Čakovice"
556
+ - "Praha-Ďáblice"
557
+ - "Praha-Dolní Chabry"
558
+ - "Praha-Dolní Měcholupy"
559
+ - "Praha-Dolní Počernice"
560
+ - "Praha-Dubeč"
561
+ - "Praha-Klánovice"
562
+ - "Praha-Koloděje"
563
+ - "Praha-Kolovraty"
564
+ - "Praha-Královice"
565
+ - "Praha-Křeslice"
566
+ - "Praha-Kunratice"
567
+ - "Praha-Libuš"
568
+ - "Praha-Lipence"
569
+ - "Praha-Lochkov"
570
+ - "Praha-Lysolaje"
571
+ - "Praha-Nebušice"
572
+ - "Praha-Nedvězí"
573
+ - "Praha-Petrovice"
574
+ - "Praha-Přední Kopanina"
575
+ - "Praha-Řeporyje"
576
+ - "Praha-Satalice"
577
+ - "Praha-Slivenec"
578
+ - "Praha-Suchdol"
579
+ - "Praha-Šeberov"
580
+ - "Praha-Štěrboholy"
581
+ - "Praha-Troja"
582
+ - "Praha-Újezd"
583
+ - "Praha-Velká Chuchle"
584
+ - "Praha-Vinoř"
585
+ - "Praha-Zbraslav"
586
+ - "Praha-Zličín"
587
+ - "Mimo HMP"
588
+ description: >-
589
+ Prague city district or municipality where the element is located.
590
+
591
+ ManagerEnum:
592
+ type: string
593
+ nullable: true
594
+ enum:
595
+ - "ROPID"
596
+ - "THMP"
597
+ - "TSK"
598
+ - "Apex"
599
+ - "Arriva"
600
+ - "BigBoard"
601
+ - "ČSAD Kladno"
602
+ - "ČSAD Střední Čechy"
603
+ - "DPP"
604
+ - "IDSK"
605
+ - "Město B.n.L.-St.Bol."
606
+ - "Město Benátky nad Jizerou"
607
+ - "Město Benešov"
608
+ - "Město Beroun"
609
+ - "Město Jesenice"
610
+ - "Město Kolín"
611
+ - "Město Kralupy nad Vltavou"
612
+ - "Město Mělník"
613
+ - "Město Mnichovo Hradiště"
614
+ - "Město Pečky"
615
+ - "Město Poděbrady"
616
+ - "Město Příbram"
617
+ - "Město Rožmitál pod Třemšínem"
618
+ - "Město Říčany"
619
+ - "Město Sázava"
620
+ - "Město Štětí"
621
+ - "Město Týnec nad Sázavou"
622
+ - "Město Votice"
623
+ - "Město Zruč nad Sázavou"
624
+ - "Městys Davle"
625
+ - "Obec Buš"
626
+ - "Obec Dolní Břežany"
627
+ - "Obec Malý Újezd"
628
+ - "Obec Přistoupim"
629
+ - "Obec Středokluky"
630
+ - "Obec Vestec"
631
+ - "Passerinvest"
632
+ - "SŽ"
633
+ - "Ostatní"
634
+ description: >-
635
+ Entity managing the element (správce prvku). Union of all kind-specific values.
636
+
637
+ OwnerEnum:
638
+ type: string
639
+ nullable: true
640
+ enum:
641
+ - "HMP"
642
+ - "ROPID"
643
+ - "TSK"
644
+ - "DPP"
645
+ - "Arriva"
646
+ - "BigBoard"
647
+ - "ČSAD Kladno"
648
+ - "ČSAD Střední Čechy"
649
+ - "IDSK"
650
+ - "Město B.n.L.-St.Bol."
651
+ - "Město Benátky nad Jizerou"
652
+ - "Město Benešov"
653
+ - "Město Beroun"
654
+ - "Město Jesenice"
655
+ - "Město Kolín"
656
+ - "Město Kralupy nad Vltavou"
657
+ - "Město Mělník"
658
+ - "Město Mnichovo Hradiště"
659
+ - "Město Pečky"
660
+ - "Město Poděbrady"
661
+ - "Město Příbram"
662
+ - "Město Rožmitál pod Třemšínem"
663
+ - "Město Říčany"
664
+ - "Město Sázava"
665
+ - "Město Štětí"
666
+ - "Město Týnec nad Sázavou"
667
+ - "Město Votice"
668
+ - "Město Zruč nad Sázavou"
669
+ - "Městys Davle"
670
+ - "Obec Buš"
671
+ - "Obec Dolní Břežany"
672
+ - "Obec Malý Újezd"
673
+ - "Obec Přistoupim"
674
+ - "Obec Středokluky"
675
+ - "Obec Vestec"
676
+ - "Passerinvest"
677
+ - "SŽ"
678
+ - "Ostatní"
679
+ description: >-
680
+ Entity owning the element (vlastník prvku). Union of all kind-specific values.
681
+
682
+ LandOwnerEnum:
683
+ type: string
684
+ nullable: true
685
+ enum:
686
+ - "HMP"
687
+ - "Passerinvest"
688
+ - "SŽ"
689
+ - "ČD"
690
+ - "Soukromá osoba"
691
+ - "Ostatní"
692
+ description: >-
693
+ Owner of the land parcel (vlastník pozemku). Union of all kind-specific values.
694
+
453
695
  FyprMetadataKindEntry:
696
+ description: >-
697
+ Metadata entry for a single element kind: navigation links and field translations.
454
698
  type: object
455
699
  required:
456
700
  - links
@@ -462,6 +706,8 @@ components:
462
706
  $ref: "#/components/schemas/FyprMetadataKindTranslations"
463
707
 
464
708
  FyprMetadataKindLinks:
709
+ description: >-
710
+ Array of navigation links for an element kind (rel + href pairs).
465
711
  type: array
466
712
  items:
467
713
  type: object
@@ -481,6 +727,8 @@ components:
481
727
  Path to the list endpoint for this element kind.
482
728
 
483
729
  FyprMetadataKindTranslations:
730
+ description: >-
731
+ Translation data for an element kind: kind-level names and per-attribute translations.
484
732
  type: object
485
733
  required:
486
734
  - kind
@@ -497,6 +745,8 @@ components:
497
745
  $ref: "#/components/schemas/FyprMetadataFieldTranslation"
498
746
 
499
747
  FyprMetadataKindTranslation:
748
+ description: >-
749
+ Czech names for an element kind (plural, singular) and its English database slug.
500
750
  type: object
501
751
  required:
502
752
  - slug_en
@@ -520,6 +770,8 @@ components:
520
770
  Czech singular name of the element kind.
521
771
 
522
772
  FyprMetadataFieldTranslation:
773
+ description: >-
774
+ Translation entry for a single element attribute: Czech slug and human-readable label.
523
775
  type: object
524
776
  required:
525
777
  - slug_cs
@@ -624,26 +876,27 @@ components:
624
876
  example: "Totem Palackeho namesti"
625
877
  description: Human-readable name of the element. May be null.
626
878
  state:
627
- type: string
879
+ allOf:
880
+ - $ref: "#/components/schemas/ElementStateEnum"
628
881
  nullable: false
629
882
  example: "Hotovo"
630
883
  description: >-
631
- Lifecycle state of the element (e.g. Plánováno, Neplánováno, Zrušeno, Hotovo, V přípravě).
884
+ Lifecycle state of the element. May not be null.
632
885
  owner:
633
- type: string
634
- nullable: true
886
+ allOf:
887
+ - $ref: "#/components/schemas/OwnerEnum"
635
888
  example: "ROPID"
636
889
  description: >-
637
890
  Organization or entity that owns the element. May be null.
638
891
  manager:
639
- type: string
640
- nullable: true
892
+ allOf:
893
+ - $ref: "#/components/schemas/ManagerEnum"
641
894
  example: "THMP"
642
895
  description: >-
643
896
  Organization or entity that manages the element. May be null.
644
897
  city_district:
645
- type: string
646
- nullable: true
898
+ allOf:
899
+ - $ref: "#/components/schemas/CityDistrictEnum"
647
900
  example: "Praha 6"
648
901
  description: >-
649
902
  Prague city district where the element is physically located.
@@ -674,10 +927,9 @@ components:
674
927
  planned_year_of_realization:
675
928
  type: string
676
929
  nullable: true
677
- example: "2025"
930
+ example: "rok 2025"
678
931
  description: >-
679
932
  Year in which the element is planned to be realized or installed.
680
- Stored as string to accommodate partial or estimated values.
681
933
  May be null.
682
934
  note:
683
935
  type: string
@@ -717,6 +969,8 @@ components:
717
969
  - source_updated_at
718
970
 
719
971
  DisplayCaseBase:
972
+ description: >-
973
+ Display case (vitrína) element. Extends ElementBase with display-case-specific fields.
720
974
  allOf:
721
975
  - $ref: "#/components/schemas/ElementBase"
722
976
  - type: object
@@ -727,14 +981,14 @@ components:
727
981
  stop_name:
728
982
  type: string
729
983
  nullable: true
730
- example: "Palackeho namesti"
984
+ example: "Palackého náměstí"
731
985
  description: >-
732
986
  Name of the public transport stop where the display case is installed.
733
987
  May be null if not yet associated with a stop.
734
988
  stop_direction:
735
989
  type: string
736
990
  nullable: true
737
- example: "smer Dejvicka"
991
+ example: "směr Dejvická"
738
992
  description: >-
739
993
  Direction indicator for the stop (e.g. towards a terminal station).
740
994
  May be null.
@@ -766,9 +1020,10 @@ components:
766
1020
  shelter_type:
767
1021
  type: string
768
1022
  nullable: true
769
- example: "standard"
1023
+ example: "Olgoj Chorchoj"
770
1024
  description: >-
771
- Type classification of the shelter or enclosure housing the display case.
1025
+ Type of the stop shelter (přístřešek) at which the display case
1026
+ is installed (e.g. "Repasovaný", "Olgoj Chorchoj", "Ostatní").
772
1027
  May be null.
773
1028
  shelter_id:
774
1029
  type: string
@@ -813,14 +1068,14 @@ components:
813
1068
  location_description:
814
1069
  type: string
815
1070
  nullable: true
816
- example: "Na sloupu u vchodu do metrostanice"
1071
+ example: "V přístřešku"
817
1072
  description: >-
818
- Human-readable description of the exact physical placement of the
819
- display case at the stop. May be null.
1073
+ Placement type of the display case at the stop
1074
+ (e.g. "Samostatně stojící", "V přístřešku"). May be null.
820
1075
  street_name:
821
1076
  type: string
822
1077
  nullable: true
823
- example: "Vaclavske namesti"
1078
+ example: "Václavské náměstí"
824
1079
  description: >-
825
1080
  Name of the street or square where the display case is located.
826
1081
  May be null.
@@ -856,10 +1111,10 @@ components:
856
1111
  cleaning_frequency:
857
1112
  type: string
858
1113
  nullable: true
859
- example: "weekly"
1114
+ example: "měsíčně"
860
1115
  description: >-
861
- Scheduled cleaning frequency for the display case (e.g. daily,
862
- weekly, monthly). May be null if no cleaning schedule is set.
1116
+ Scheduled cleaning frequency for the display case. Free-text field.
1117
+ May be null.
863
1118
 
864
1119
  InformationPanel:
865
1120
  description: >-
@@ -943,7 +1198,7 @@ components:
943
1198
  stop_name:
944
1199
  type: string
945
1200
  nullable: true
946
- example: "Palackeho namesti"
1201
+ example: "Palackého náměstí"
947
1202
  description: >-
948
1203
  Human-readable name of the stop where the panel is installed.
949
1204
  May be null.
@@ -985,9 +1240,9 @@ components:
985
1240
  Cadastral parcel number of the land where the panel is installed.
986
1241
  May be null.
987
1242
  land_owner:
988
- type: string
989
- nullable: true
990
- example: "Hlavni mesto Praha"
1243
+ allOf:
1244
+ - $ref: "#/components/schemas/LandOwnerEnum"
1245
+ example: "HMP"
991
1246
  description: >-
992
1247
  Owner of the land parcel. May be null.
993
1248
  workday_boarding_count:
@@ -1007,24 +1262,24 @@ components:
1007
1262
  location_description:
1008
1263
  type: string
1009
1264
  nullable: true
1010
- example: "At the corner of Anglicka and Blanicka streets"
1265
+ example: "Na rohu Anglické a Blanické ulice"
1011
1266
  description: >-
1012
1267
  Free-text description of the panel's physical location.
1013
1268
  May be null.
1014
1269
  location_verification_on_street_light:
1015
- type: string
1016
- nullable: true
1017
- example: "VO-12345"
1270
+ allOf:
1271
+ - $ref: "#/components/schemas/YesNoPlanEnum"
1272
+ example: "ANO"
1018
1273
  description: >-
1019
- Reference to the street light pole used to verify installation
1020
- position. May be null.
1274
+ Whether the installation position was verified against a street
1275
+ light pole. May be null.
1021
1276
  shelter_type:
1022
1277
  type: string
1023
1278
  nullable: true
1024
- example: "standard"
1279
+ example: "Olgoj Chorchoj"
1025
1280
  description: >-
1026
- Type or model of the shelter associated with this panel.
1027
- May be null.
1281
+ Type of the stop shelter (přístřešek) associated with this panel
1282
+ (e.g. "Repasovaný", "Olgoj Chorchoj", "Ostatní"). May be null.
1028
1283
  shelter_id:
1029
1284
  type: string
1030
1285
  nullable: true
@@ -1042,54 +1297,56 @@ components:
1042
1297
  surface_type:
1043
1298
  type: string
1044
1299
  nullable: true
1045
- example: "asphalt"
1300
+ example: "Asfalt"
1046
1301
  description: >-
1047
- Type of ground surface at the installation site. May be null.
1302
+ Type of ground surface at the installation site (e.g. "Asfalt",
1303
+ "Dlažba", "Mozaika", "Zeleň", "VO", "Ostatní"). May be null.
1048
1304
  connection_state:
1049
- type: string
1050
- nullable: true
1051
- example: "connected"
1305
+ allOf:
1306
+ - $ref: "#/components/schemas/YesNoPlanEnum"
1307
+ example: "ANO"
1052
1308
  description: >-
1053
- Current connectivity state of the panel (e.g. connected,
1054
- disconnected, pending). May be null.
1309
+ Whether the panel is connected to power. May be null.
1055
1310
  connection_type:
1056
1311
  type: string
1057
1312
  nullable: true
1058
1313
  example: "PRE"
1059
1314
  description: >-
1060
- Type of electrical power supply connection for the panel. May be null.
1315
+ Electrical power supply connection type (e.g. "PRE", "VO", "TSK",
1316
+ "SŽ", "Solární panel", "Baterie", "Ostatní"). May be null.
1061
1317
  connection_mode:
1062
1318
  type: string
1063
1319
  nullable: true
1064
- example: "static_ip"
1320
+ example: "Celodenní"
1065
1321
  description: >-
1066
- Network addressing mode used for the panel connection.
1067
- May be null.
1322
+ Power supply mode for the panel ("Celodenní", "Noční",
1323
+ "Lze vyčlenit 24x7"). May be null.
1068
1324
  priority:
1069
1325
  type: string
1070
1326
  nullable: true
1071
- example: "high"
1327
+ example: "p1"
1072
1328
  description: >-
1073
- Installation or maintenance priority assigned to this panel.
1074
- May be null.
1329
+ Installation or maintenance priority assigned to this panel
1330
+ ("p1" to "p5"). May be null.
1075
1331
  investor_action:
1076
1332
  type: string
1077
1333
  nullable: true
1078
- example: "ROPID-2024-001"
1334
+ example: "ROPID"
1079
1335
  description: >-
1080
- Investor action or project reference linked to this panel.
1336
+ Investor responsible for the action linked to this panel
1337
+ (e.g. "HMP", "DPP", "MČ", "THMP", "TSK", "ROPID", "SŽ", "Ostatní").
1081
1338
  May be null.
1082
1339
  design_request:
1083
1340
  type: string
1084
1341
  nullable: true
1085
- example: "PR-2024-042"
1342
+ example: "ANO"
1086
1343
  description: >-
1087
- Reference identifier for the design (projekce) request.
1344
+ Whether a design (projekce) has been requested ("ANO", "NE", "Zrušeno").
1088
1345
  May be null.
1089
1346
  design_state:
1090
- type: string
1091
- nullable: true
1092
- example: "completed"
1347
+ allOf:
1348
+ - $ref: "#/components/schemas/PhaseStateEnum"
1349
+ example: "Hotovo"
1093
1350
  description: >-
1094
1351
  Current state of the design phase. May be null.
1095
1352
  design_order_number:
@@ -1099,19 +1356,18 @@ components:
1099
1356
  description: >-
1100
1357
  Order number issued for the design phase. May be null.
1101
1358
  design_registry_publication:
1102
- type: string
1103
- nullable: true
1104
- example: "2024/042"
1359
+ allOf:
1360
+ - $ref: "#/components/schemas/YesNoEnum"
1361
+ example: "ANO"
1105
1362
  description: >-
1106
- Publication reference in the public procurement registry for the
1107
- design order. May be null.
1363
+ Whether the design order was published in the public procurement
1364
+ registry. May be null.
1108
1365
  design_invoice_paid:
1109
- type: string
1110
- nullable: true
1111
- example: "yes"
1366
+ allOf:
1367
+ - $ref: "#/components/schemas/YesNoEnum"
1368
+ example: "ANO"
1112
1369
  description: >-
1113
- Indicates whether the design phase invoice has been paid.
1114
- May be null.
1370
+ Whether the design phase invoice has been paid. May be null.
1115
1371
  production_order_number:
1116
1372
  type: string
1117
1373
  nullable: true
@@ -1119,25 +1375,24 @@ components:
1119
1375
  description: >-
1120
1376
  Order number issued for the production (vyroba) phase. May be null.
1121
1377
  production_state:
1122
- type: string
1123
- nullable: true
1124
- example: "in_progress"
1378
+ allOf:
1379
+ - $ref: "#/components/schemas/PhaseStateEnum"
1380
+ example: "Hotovo"
1125
1381
  description: >-
1126
1382
  Current state of the production phase. May be null.
1127
1383
  production_registry_publication:
1128
- type: string
1129
- nullable: true
1130
- example: "2024/142"
1384
+ allOf:
1385
+ - $ref: "#/components/schemas/YesNoEnum"
1386
+ example: "ANO"
1131
1387
  description: >-
1132
- Publication reference in the public procurement registry for the
1133
- production order. May be null.
1388
+ Whether the production order was published in the public procurement
1389
+ registry. May be null.
1134
1390
  production_invoice_paid:
1135
- type: string
1136
- nullable: true
1137
- example: "no"
1391
+ allOf:
1392
+ - $ref: "#/components/schemas/YesNoEnum"
1393
+ example: "ANO"
1138
1394
  description: >-
1139
- Indicates whether the production phase invoice has been paid.
1140
- May be null.
1395
+ Whether the production phase invoice has been paid. May be null.
1141
1396
  realization_request:
1142
1397
  type: boolean
1143
1398
  nullable: true
@@ -1146,9 +1401,9 @@ components:
1146
1401
  Whether a realization (realizace) request has been raised for
1147
1402
  this panel. May be null.
1148
1403
  realization_state:
1149
- type: string
1150
- nullable: true
1151
- example: "pending"
1404
+ allOf:
1405
+ - $ref: "#/components/schemas/PhaseStateEnum"
1406
+ example: "Hotovo"
1152
1407
  description: >-
1153
1408
  Current state of the realization phase. May be null.
1154
1409
  realization_order_number:
@@ -1158,19 +1413,18 @@ components:
1158
1413
  description: >-
1159
1414
  Order number issued for the realization phase. May be null.
1160
1415
  realization_registry_publication:
1161
- type: string
1162
- nullable: true
1163
- example: "2024/242"
1416
+ allOf:
1417
+ - $ref: "#/components/schemas/YesNoEnum"
1418
+ example: "ANO"
1164
1419
  description: >-
1165
- Publication reference in the public procurement registry for the
1166
- realization order. May be null.
1420
+ Whether the realization order was published in the public procurement
1421
+ registry. May be null.
1167
1422
  realization_invoice_paid:
1168
- type: string
1169
- nullable: true
1170
- example: "yes"
1423
+ allOf:
1424
+ - $ref: "#/components/schemas/YesNoEnum"
1425
+ example: "ANO"
1171
1426
  description: >-
1172
- Indicates whether the realization phase invoice has been paid.
1173
- May be null.
1427
+ Whether the realization phase invoice has been paid. May be null.
1174
1428
  name_for_visually_impaired:
1175
1429
  type: string
1176
1430
  nullable: true
@@ -1210,10 +1464,10 @@ components:
1210
1464
  data_source:
1211
1465
  type: string
1212
1466
  nullable: true
1213
- example: "golemio"
1467
+ example: "Golemio"
1214
1468
  description: >-
1215
- Identifier of the data source feeding real-time information to
1216
- this panel. May be null.
1469
+ Data source feeding real-time information to this panel
1470
+ (e.g. "Golemio", "MPV", "GTFS-RT", "CIS", "Ostatní"). May be null.
1217
1471
  imsi:
1218
1472
  type: string
1219
1473
  nullable: true
@@ -1224,9 +1478,10 @@ components:
1224
1478
  connection_point:
1225
1479
  type: string
1226
1480
  nullable: true
1227
- example: "cabinet-A3"
1481
+ example: "Přístřešek"
1228
1482
  description: >-
1229
- Specification of location type where the device is connected.
1483
+ Location type where the panel is connected to power
1484
+ (e.g. "Přístřešek", "VO", "Soukromá budova", "Ostatní"). May be null.
1230
1485
  connection_point_number:
1231
1486
  type: string
1232
1487
  nullable: true
@@ -1236,9 +1491,10 @@ components:
1236
1491
  foundation_type:
1237
1492
  type: string
1238
1493
  nullable: true
1239
- example: "concrete_block"
1494
+ example: "Klasický"
1240
1495
  description: >-
1241
- Type of physical foundation used to mount the panel. May be null.
1496
+ Type of physical foundation used to mount the panel
1497
+ ("Klasický", "Plochý", "Atyp"). May be null.
1242
1498
  warranty_end:
1243
1499
  type: string
1244
1500
  format: date
@@ -1303,7 +1559,7 @@ components:
1303
1559
  example: true
1304
1560
  description: >-
1305
1561
  Whether this panel has been formally handed over to OZP
1306
- (Odbor zelene a pro verejny prostor) for management. May be null.
1562
+ (Odbor životního prostředí) for management. May be null.
1307
1563
  dpp_documentation_request:
1308
1564
  type: boolean
1309
1565
  nullable: true
@@ -1341,8 +1597,8 @@ components:
1341
1597
  items:
1342
1598
  type: string
1343
1599
  example:
1344
- - "technical_drawing"
1345
- - "site_plan"
1600
+ - "Předávací protokol instalace."
1601
+ - "Zpráva o výchozí revizi."
1346
1602
  description: >-
1347
1603
  List of document types submitted to ROPID as part of the
1348
1604
  documentation package. May be null.
@@ -1360,7 +1616,8 @@ components:
1360
1616
  items:
1361
1617
  type: string
1362
1618
  example:
1363
- - "installation_protocol"
1619
+ - "Předávací protokol instalace."
1620
+ - "Zpráva o výchozí revizi."
1364
1621
  description: >-
1365
1622
  List of document types submitted to DPP as part of the
1366
1623
  documentation package. May be null.
@@ -1415,30 +1672,32 @@ components:
1415
1672
  cleaning_frequency:
1416
1673
  type: string
1417
1674
  nullable: true
1418
- example: "monthly"
1675
+ example: "měsíčně"
1419
1676
  description: >-
1420
- Scheduled cleaning frequency for this panel. May be null.
1677
+ Scheduled cleaning frequency for this panel. Free-text field.
1678
+ May be null.
1421
1679
  electricity_consumption_price:
1422
1680
  type: number
1423
- format: float
1681
+ format: double
1424
1682
  nullable: true
1425
1683
  example: 3.75
1426
1684
  description: >-
1427
- Unit price per kWh charged under the electricity supply contract.
1428
- Decimal values are permitted. May be null.
1685
+ Price for electricity consumption (cena za odběr elektřiny).
1686
+ May be null.
1429
1687
  construction_type:
1430
1688
  type: string
1431
1689
  nullable: true
1432
- example: "pole_mounted"
1690
+ example: "Samostatně stojící"
1433
1691
  description: >-
1434
- Type of physical construction used for this panel
1435
- (e.g. pole_mounted, wall_mounted, freestanding). May be null.
1692
+ Construction type of the panel (e.g. "Samostatně stojící",
1693
+ "V přístřešku", "V označníku", "Na konstrukci - VO", "Ostatní").
1694
+ May be null.
1436
1695
  panel_size:
1437
1696
  type: integer
1438
1697
  nullable: true
1439
- example: 6
1698
+ example: 5
1440
1699
  description: >-
1441
- Count of rows for text or data on the panel. May be null.
1700
+ Number of rows the information panel can display. May be null.
1442
1701
  design_price_without_vat:
1443
1702
  type: number
1444
1703
  format: float
@@ -1552,14 +1811,14 @@ components:
1552
1811
  street_name:
1553
1812
  type: string
1554
1813
  nullable: true
1555
- example: "Vaclavske namesti"
1814
+ example: "Václavské náměstí"
1556
1815
  description: >-
1557
1816
  Name of the street where the obelisk is physically located.
1558
1817
  May be null if the street name is not recorded.
1559
1818
  location_description:
1560
1819
  type: string
1561
1820
  nullable: true
1562
- example: "Near the main entrance of the metro station, pillar B."
1821
+ example: "U hlavního vchodu do stanice metra, sloup B."
1563
1822
  description: >-
1564
1823
  Free-text description of the obelisk's exact placement within
1565
1824
  its location. May be null.
@@ -1571,19 +1830,18 @@ components:
1571
1830
  Cadastral land parcel number identifying the plot on which the
1572
1831
  obelisk stands. May be null.
1573
1832
  land_owner:
1574
- type: string
1575
- nullable: true
1576
- example: "Hlavni mesto Praha"
1833
+ allOf:
1834
+ - $ref: "#/components/schemas/LandOwnerEnum"
1835
+ example: "HMP"
1577
1836
  description: >-
1578
- Name of the entity that owns the land parcel where the obelisk
1579
- is installed. May be null.
1837
+ Owner of the land parcel where the obelisk is installed. May be null.
1580
1838
  priority:
1581
1839
  type: string
1582
1840
  nullable: true
1583
- example: "HIGH"
1841
+ example: "p1"
1584
1842
  description: >-
1585
- Operational priority assigned to the obelisk for maintenance
1586
- scheduling purposes. May be null.
1843
+ Maintenance priority assigned to this obelisk ("p1" to "p5").
1844
+ May be null.
1587
1845
  asset_registered:
1588
1846
  type: boolean
1589
1847
  nullable: true
@@ -1606,24 +1864,22 @@ components:
1606
1864
  Indicates whether the obelisk is covered by an insurance
1607
1865
  policy. May be null if insurance status is not recorded.
1608
1866
  insurance_state:
1609
- type: string
1610
- nullable: true
1611
- example: "ACTIVE"
1867
+ allOf:
1868
+ - $ref: "#/components/schemas/InsuranceStateEnum"
1869
+ example: "V přípravě"
1612
1870
  description: >-
1613
- Current state of the insurance policy for the obelisk
1614
- (e.g. ACTIVE, EXPIRED). May be null.
1871
+ Current state of the insurance policy for the obelisk. May be null.
1615
1872
  handed_over_to_ozp:
1616
1873
  type: boolean
1617
1874
  nullable: true
1618
1875
  example: false
1619
1876
  description: >-
1620
- Indicates whether the obelisk has been formally handed over to
1621
- the OZP (Odbor zelene a prostredi) department for ongoing
1622
- management. May be null.
1877
+ Whether this obelisk has been formally handed over to OZP
1878
+ (Odbor životního prostředí) for management. May be null.
1623
1879
  comments:
1624
1880
  type: string
1625
1881
  nullable: true
1626
- example: "Surface damage reported on the north face. Scheduled for repair Q3 2025."
1882
+ example: "Poškození povrchu na severní straně."
1627
1883
  description: >-
1628
1884
  Free-text comments or operational notes associated with the
1629
1885
  obelisk. May be null.
@@ -1637,10 +1893,10 @@ components:
1637
1893
  construction_type:
1638
1894
  type: string
1639
1895
  nullable: true
1640
- example: "STEEL_FRAME"
1896
+ example: "Standard"
1641
1897
  description: >-
1642
- Type of construction used for the obelisk (e.g. STEEL_FRAME,
1643
- CONCRETE, COMPOSITE). May be null.
1898
+ Construction type of the obelisk ("Široký", "Standard", "Úzký").
1899
+ May be null.
1644
1900
  price_without_vat:
1645
1901
  type: number
1646
1902
  nullable: true
@@ -1682,10 +1938,10 @@ components:
1682
1938
  location_description:
1683
1939
  type: string
1684
1940
  nullable: true
1685
- example: "Near bus stop exit B, adjacent to pedestrian crossing"
1941
+ example: "U výstupu B ze zastávky, vedle přechodu pro chodce."
1686
1942
  description: >-
1687
1943
  Free-text description of the precise installation location.
1688
- May be null if not yet recorded.
1944
+ May be null.
1689
1945
  land_parcel_number:
1690
1946
  type: string
1691
1947
  nullable: true
@@ -1694,12 +1950,11 @@ components:
1694
1950
  Cadastral land parcel number of the plot on which the signpost
1695
1951
  is installed. May be null.
1696
1952
  land_owner:
1697
- type: string
1698
- nullable: true
1699
- example: "Hlavni mesto Praha"
1953
+ allOf:
1954
+ - $ref: "#/components/schemas/LandOwnerEnum"
1955
+ example: "HMP"
1700
1956
  description: >-
1701
- Name of the land parcel owner. May be null if ownership has not
1702
- been determined.
1957
+ Owner of the land parcel where the signpost is installed. May be null.
1703
1958
  street_light_number:
1704
1959
  type: string
1705
1960
  nullable: true
@@ -1717,10 +1972,10 @@ components:
1717
1972
  priority:
1718
1973
  type: string
1719
1974
  nullable: true
1720
- example: "HIGH"
1975
+ example: "p1"
1721
1976
  description: >-
1722
- Installation or maintenance priority classification assigned to
1723
- this signpost. May be null.
1977
+ Maintenance priority assigned to this signpost ("p1" to "p5").
1978
+ May be null.
1724
1979
  asset_registered:
1725
1980
  type: boolean
1726
1981
  nullable: true
@@ -1743,24 +1998,22 @@ components:
1743
1998
  Indicates whether the signpost is covered by an insurance policy.
1744
1999
  May be null if insurance status is unknown.
1745
2000
  insurance_state:
1746
- type: string
1747
- nullable: true
1748
- example: "ACTIVE"
2001
+ allOf:
2002
+ - $ref: "#/components/schemas/InsuranceStateEnum"
2003
+ example: "V přípravě"
1749
2004
  description: >-
1750
- Current state of the insurance coverage for the signpost
1751
- (e.g. ACTIVE, EXPIRED). May be null.
2005
+ Current state of the insurance coverage for the signpost. May be null.
1752
2006
  handed_over_to_ozp:
1753
2007
  type: boolean
1754
2008
  nullable: true
1755
2009
  example: false
1756
2010
  description: >-
1757
- Indicates whether the signpost has been formally handed over
1758
- to OZP (maintenance department) for ongoing administration.
1759
- May be null.
2011
+ Whether this signpost has been formally handed over to OZP
2012
+ (Odbor životního prostředí) for management. May be null.
1760
2013
  comments:
1761
2014
  type: string
1762
2015
  nullable: true
1763
- example: "Requires re-painting before next season."
2016
+ example: "Nutno přelakovat před příští sezonou."
1764
2017
  description: >-
1765
2018
  Free-text comments or operational notes recorded by field staff.
1766
2019
  May be null.
@@ -1774,10 +2027,10 @@ components:
1774
2027
  construction_type:
1775
2028
  type: string
1776
2029
  nullable: true
1777
- example: "STEEL_POLE"
2030
+ example: "Samostatně stojící"
1778
2031
  description: >-
1779
- Type of construction or structural form of the signpost
1780
- (e.g. STEEL_POLE, WALL_MOUNTED). May be null.
2032
+ Construction type of the signpost ("Samostatně stojící",
2033
+ "Na konstrukci - VO", "Totem"). May be null.
1781
2034
  price_without_vat:
1782
2035
  type: number
1783
2036
  format: double
@@ -1812,14 +2065,14 @@ components:
1812
2065
  panel_size:
1813
2066
  type: string
1814
2067
  nullable: true
1815
- example: "Standart"
2068
+ example: "Standard"
1816
2069
  description: >-
1817
- Size of the totem's display panel (e.g. "Standart", "Atyp").
1818
- May be null if not yet specified.
2070
+ Size of the totem's display panel ("Standard", "Atyp", "Mini",
2071
+ "Menší"). May be null.
1819
2072
  locality:
1820
2073
  type: string
1821
2074
  nullable: true
1822
- example: "Palackeho namesti"
2075
+ example: "Palackého náměstí"
1823
2076
  description: >-
1824
2077
  Named locality or area where the totem is installed.
1825
2078
  May be null.
@@ -1829,37 +2082,35 @@ components:
1829
2082
  items:
1830
2083
  type: string
1831
2084
  example:
1832
- - "metro_a"
1833
- - "bus"
2085
+ - "metro"
1834
2086
  description: >-
1835
- List of icon identifiers displayed on the totem face (e.g. transit
1836
- mode icons). May be null if no icons are configured.
2087
+ List of transit mode icons displayed on the totem face
2088
+ (e.g. "metro", "vlak", "S", "P+R"). May be null.
1837
2089
  line:
1838
2090
  type: array
1839
2091
  nullable: true
1840
2092
  items:
1841
2093
  type: string
1842
2094
  example:
1843
- - "119"
1844
- - "218"
2095
+ - "A"
1845
2096
  description: >-
1846
- Transit line identifiers served at or referenced by this totem.
1847
- May be null.
2097
+ Metro or rail lines associated with this totem
2098
+ (e.g. "A", "B", "C", "D", "vlak"). May be null.
1848
2099
  priority:
1849
2100
  type: integer
1850
2101
  nullable: true
1851
2102
  example: 1
1852
2103
  description: >-
1853
- Installation or operational priority rank for this totem.
1854
- Integer value; lower numbers indicate higher priority.
2104
+ Installation or operational priority rank for this totem (1–5).
1855
2105
  May be null.
1856
2106
  site_survey:
1857
2107
  type: string
1858
2108
  nullable: true
1859
- example: "Provedeno 2024-03-15"
2109
+ example: "Realizováno"
1860
2110
  description: >-
1861
- Free-text record of the site survey result or reference.
1862
- May be null if no survey has been conducted.
2111
+ State of the site survey (místní šetření) for this totem
2112
+ (e.g. "Realizováno", "K realizaci", "Prověřit - THMP",
2113
+ "Nelze osadit"). May be null.
1863
2114
  installation_height:
1864
2115
  type: string
1865
2116
  nullable: true
@@ -1897,12 +2148,11 @@ components:
1897
2148
  Indicates whether a building permit has been obtained for this
1898
2149
  totem installation. May be null if status is unknown.
1899
2150
  building_permit_state:
1900
- type: string
1901
- nullable: true
1902
- example: "Plánováno"
2151
+ allOf:
2152
+ - $ref: "#/components/schemas/BuildingPermitStateEnum"
2153
+ example: "Hotovo"
1903
2154
  description: >-
1904
- Current state of the building permit process
1905
- (e.g. Plánováno, Neplánováno, Zrušeno, Hotovo). May be null.
2155
+ Current state of the building permit process. May be null.
1906
2156
  location_note:
1907
2157
  type: string
1908
2158
  nullable: true
@@ -1918,12 +2168,11 @@ components:
1918
2168
  Reference or summary of the formal site survey report.
1919
2169
  May be null if no report exists.
1920
2170
  order_state:
1921
- type: string
1922
- nullable: true
1923
- example: "IN_PROGRESS"
2171
+ allOf:
2172
+ - $ref: "#/components/schemas/OrderStateEnum"
2173
+ example: "Hotovo"
1924
2174
  description: >-
1925
- Current state of the procurement order for this totem
1926
- (e.g. DRAFT, SUBMITTED, IN_PROGRESS, COMPLETED). May be null.
2175
+ Current state of the procurement order for this totem. May be null.
1927
2176
  order_number:
1928
2177
  type: string
1929
2178
  nullable: true
@@ -1980,7 +2229,7 @@ components:
1980
2229
  stop_name:
1981
2230
  type: string
1982
2231
  nullable: true
1983
- example: "Palackeho namesti"
2232
+ example: "Palackého náměstí"
1984
2233
  description: >-
1985
2234
  Name of the public transport stop associated with this totem.
1986
2235
  May be null.
@@ -2058,17 +2307,16 @@ components:
2058
2307
  nullable: true
2059
2308
  example: false
2060
2309
  description: >-
2061
- Indicates whether the totem has been formally handed over to the
2062
- OZP (public space department) for ongoing maintenance.
2063
- May be null.
2310
+ Whether this totem has been formally handed over to OZP
2311
+ (Odbor životního prostředí) for management. May be null.
2064
2312
  ropid_documentation_submitted:
2065
2313
  type: array
2066
2314
  nullable: true
2067
2315
  items:
2068
2316
  type: string
2069
2317
  example:
2070
- - "technical_spec"
2071
- - "as_built_drawing"
2318
+ - "Předávací protokol"
2319
+ - "Zpráva o výchozí revizi"
2072
2320
  description: >-
2073
2321
  List of documentation items submitted to ROPID as part of the
2074
2322
  handover package. May be null.
@@ -2102,12 +2350,11 @@ components:
2102
2350
  Prague Public Transit (DPP) internal priority rank for this totem.
2103
2351
  Lower values indicate higher priority. May be null.
2104
2352
  insurance_state:
2105
- type: string
2106
- nullable: true
2107
- example: "ACTIVE"
2353
+ allOf:
2354
+ - $ref: "#/components/schemas/InsuranceStateEnum"
2355
+ example: "V přípravě"
2108
2356
  description: >-
2109
- Current state of the insurance coverage for this totem
2110
- (e.g. ACTIVE, EXPIRED, NOT_REQUIRED). May be null.
2357
+ Current state of the insurance coverage for this totem. May be null.
2111
2358
  comments:
2112
2359
  type: string
2113
2360
  nullable: true
@@ -2151,18 +2398,18 @@ components:
2151
2398
  cleaning_frequency:
2152
2399
  type: string
2153
2400
  nullable: true
2154
- example: "monthly"
2401
+ example: "měsíčně"
2155
2402
  description: >-
2156
- Scheduled cleaning frequency for this totem
2157
- (e.g. weekly, monthly, quarterly). May be null.
2403
+ Scheduled cleaning frequency for this totem. Free-text field.
2404
+ May be null.
2158
2405
  electricity_consumption_price:
2159
2406
  type: number
2160
2407
  format: double
2161
2408
  nullable: true
2162
- example: 3500.00
2409
+ example: 3.75
2163
2410
  description: >-
2164
- Annual electricity consumption cost for this totem in Czech crowns,
2165
- excluding VAT. May be null.
2411
+ Price for electricity consumption (cena za odběr elektřiny).
2412
+ May be null.
2166
2413
  ropid_element_id:
2167
2414
  type: string
2168
2415
  nullable: true
@@ -2173,10 +2420,10 @@ components:
2173
2420
  construction_type:
2174
2421
  type: string
2175
2422
  nullable: true
2176
- example: "STANDALONE"
2423
+ example: "VO"
2177
2424
  description: >-
2178
- Construction or mounting type of the totem
2179
- (e.g. STANDALONE, POLE_MOUNTED, WALL_MOUNTED). May be null.
2425
+ Construction type of the totem ("SS", "VO", "TV", "Digi Panel").
2426
+ May be null.
2180
2427
  production_price_without_vat:
2181
2428
  type: number
2182
2429
  format: double
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/fypr",
3
- "version": "1.8.0-dev.2611358386",
3
+ "version": "1.8.0-dev.2614520446",
4
4
  "description": "Golemio FYPR Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",