@moxi.gmbh/moxi-typescriptmodels 0.1.3011-test-server → 0.19.18

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.
@@ -798,15 +798,6 @@ export namespace com.moxi.api.geojson.common.GeoJson {
798
798
 
799
799
  }
800
800
 
801
- export namespace com.moxi.api.grpc {
802
-
803
- export interface CeliosStreamPulse {
804
- target?: string;
805
- type?: com.moxi.api.grpc.common.GrpcStreamType;
806
- }
807
-
808
- }
809
-
810
801
  export namespace com.moxi.api.grpc {
811
802
 
812
803
  export interface RegisterEinsatz {
@@ -816,33 +807,6 @@ export namespace com.moxi.api.grpc {
816
807
 
817
808
  }
818
809
 
819
- export namespace com.moxi.api.grpc {
820
-
821
- export interface StartCeliosStream {
822
- target?: string;
823
- type?: com.moxi.api.grpc.common.GrpcStreamType;
824
- }
825
-
826
- }
827
-
828
- export namespace com.moxi.api.grpc {
829
-
830
- export interface StopCeliosStream {
831
- target?: string;
832
- type?: com.moxi.api.grpc.common.GrpcStreamType;
833
- }
834
-
835
- }
836
-
837
- export namespace com.moxi.api.grpc.common {
838
-
839
- export interface GrpcStreamId {
840
- target?: string;
841
- type?: com.moxi.api.grpc.common.GrpcStreamType;
842
- }
843
-
844
- }
845
-
846
810
  export namespace com.moxi.api.integrations {
847
811
 
848
812
  export interface RemoveSettings extends com.moxi.api.account.AccountUpdate {
@@ -1199,7 +1163,7 @@ export namespace com.moxi.api.permissions.drive.common {
1199
1163
  export namespace com.moxi.api.permissions.drive.common {
1200
1164
 
1201
1165
  export interface DrivePermissionFilter {
1202
- type: "ambulance" | "emergencyAmbulance" | "intensiveCareAmbulance" | "intensiveCareHelicopter" | "taxi";
1166
+ type: "ambulance" | "taxi";
1203
1167
  }
1204
1168
 
1205
1169
  }
@@ -1223,30 +1187,6 @@ export namespace com.moxi.api.permissions.drive.common.DrivePermissionInfo {
1223
1187
 
1224
1188
  }
1225
1189
 
1226
- export namespace com.moxi.api.permissions.drive.common {
1227
-
1228
- export interface EmergencyAmbulanceFilter extends com.moxi.api.permissions.drive.common.DrivePermissionFilter {
1229
- type: "emergencyAmbulance";
1230
- }
1231
-
1232
- }
1233
-
1234
- export namespace com.moxi.api.permissions.drive.common {
1235
-
1236
- export interface IntensiveCareAmbulanceFilter extends com.moxi.api.permissions.drive.common.DrivePermissionFilter {
1237
- type: "intensiveCareAmbulance";
1238
- }
1239
-
1240
- }
1241
-
1242
- export namespace com.moxi.api.permissions.drive.common {
1243
-
1244
- export interface IntensiveCareHelicopterFilter extends com.moxi.api.permissions.drive.common.DrivePermissionFilter {
1245
- type: "intensiveCareHelicopter";
1246
- }
1247
-
1248
- }
1249
-
1250
1190
  export namespace com.moxi.api.permissions.drive.common {
1251
1191
 
1252
1192
  export interface Region {
@@ -1379,14 +1319,11 @@ export namespace com.moxi.api.refdata {
1379
1319
 
1380
1320
  export namespace com.moxi.api.refdata.common {
1381
1321
 
1382
- /**
1383
- * Address info of a google-validated address, including geolocation and district code
1384
- */
1385
1322
  export interface AddressInfo {
1386
1323
  addition?: string;
1387
1324
  city?: string;
1388
1325
  /**
1389
- * Derived from districtNutsCode
1326
+ * The NUTS country code, derived from districtNutsCode
1390
1327
  */
1391
1328
  country?: string;
1392
1329
  districtNutsCode?: string;
@@ -1395,12 +1332,12 @@ export namespace com.moxi.api.refdata.common {
1395
1332
  number?: string;
1396
1333
  placeName?: string;
1397
1334
  /**
1398
- * Derived from districtNutsCode
1335
+ * The NUTS level 1 code, derived from districtNutsCode
1399
1336
  */
1400
1337
  state?: string;
1401
1338
  street?: string;
1402
1339
  /**
1403
- * Derived from districtNutsCode
1340
+ * The NUTS level 2 code, derived from districtNutsCode
1404
1341
  */
1405
1342
  subState?: string;
1406
1343
  zipCode?: string;
@@ -1541,14 +1478,14 @@ export namespace com.moxi.api.ride {
1541
1478
  export namespace com.moxi.api.ride {
1542
1479
 
1543
1480
  export interface BookRide extends com.moxi.api.ride.CreateRideCommand {
1544
- info?: com.moxi.api.ride.common.RideInfoUnion;
1481
+ info?: com.moxi.api.ride.common.RideInfo;
1545
1482
  }
1546
1483
 
1547
1484
  }
1548
1485
 
1549
1486
  export namespace com.moxi.api.ride {
1550
1487
 
1551
- export interface CancelRide extends com.moxi.api.ride.RideCommand {
1488
+ export interface CancelRide extends com.moxi.api.ride.RideBookerCommand {
1552
1489
  reason?: string;
1553
1490
  }
1554
1491
 
@@ -1754,7 +1691,7 @@ export namespace com.moxi.api.ride {
1754
1691
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
1755
1692
  */
1756
1693
  export interface SaveRide extends com.moxi.api.ride.CreateRideCommand {
1757
- info?: com.moxi.api.ride.common.RideInfoUnion;
1694
+ info?: com.moxi.api.ride.common.RideInfo;
1758
1695
  }
1759
1696
 
1760
1697
  }
@@ -1763,7 +1700,7 @@ export namespace com.moxi.api.ride {
1763
1700
 
1764
1701
  export interface UpdateRide extends com.moxi.api.ride.RideBookerCommand {
1765
1702
  booker?: com.moxi.api.permissions.common.AccountOrTeamRef;
1766
- info?: com.moxi.api.ride.common.RideInfoUnion;
1703
+ info?: com.moxi.api.ride.common.RideInfo;
1767
1704
  }
1768
1705
 
1769
1706
  }
@@ -1779,22 +1716,22 @@ export namespace com.moxi.api.ride {
1779
1716
  export namespace com.moxi.api.ride.common {
1780
1717
 
1781
1718
  /**
1782
- * Filled if (and only if) vehicleType == ambulance
1719
+ * Mandatory if the vehicleType is ambulance, forbidden if taxi
1783
1720
  */
1784
1721
  export interface AmbulanceInfo {
1785
1722
  /**
1786
- * Derived from infectionDescription != blank
1723
+ * True if infectionDescription is given
1787
1724
  */
1788
1725
  hasInfection?: boolean;
1789
1726
  infectionDescription?: string;
1790
1727
  monitoringDescription?: string;
1791
1728
  oxygenLiterPerHour?: number;
1792
1729
  /**
1793
- * Derived from monitoringDescription != blank
1730
+ * True if monitoringDescription is given
1794
1731
  */
1795
1732
  requiresMonitoring?: boolean;
1796
1733
  /**
1797
- * Derived from oxygenLiterPerHour != null
1734
+ * True if oxygenLiterPerHour is given
1798
1735
  */
1799
1736
  requiresOxygen?: boolean;
1800
1737
  requiresSuctionAspirator?: boolean;
@@ -1834,76 +1771,6 @@ export namespace com.moxi.api.ride.common {
1834
1771
 
1835
1772
  }
1836
1773
 
1837
- export namespace com.moxi.api.ride.common {
1838
-
1839
- /**
1840
- * Ride information specific for intensive care rides.
1841
- */
1842
- export interface IntensiveCareRideInfo extends com.moxi.api.ride.common.RideInfo {
1843
- medicalData?: com.moxi.api.ride.common.MedicalData;
1844
- patientMedicalCondition?: string;
1845
- vehicleType: "intensiveCareAmbulance";
1846
- }
1847
-
1848
- }
1849
-
1850
- export namespace com.moxi.api.ride.common {
1851
-
1852
- export interface MedicalData {
1853
- activeSubstances?: com.moxi.api.ride.common.MonitoredValue;
1854
- administrativeJourney?: string;
1855
- alarmNumber?: number;
1856
- analogueSedated?: boolean;
1857
- catecholamines?: boolean;
1858
- cpapAsb?: boolean;
1859
- dkvBipap?: boolean;
1860
- ecmo?: boolean;
1861
- fio2AboveZeroPointFive?: boolean;
1862
- highFlowOxygenTherapy?: boolean;
1863
- iabp?: boolean;
1864
- ibpMonitoring?: boolean;
1865
- incubator?: boolean;
1866
- infection?: com.moxi.api.ride.common.MonitoredValue;
1867
- infusomats?: com.moxi.api.ride.common.MonitoredValue;
1868
- intubated?: boolean;
1869
- ippvCppv?: boolean;
1870
- niv?: boolean;
1871
- oriented?: boolean;
1872
- otherMonitoring?: com.moxi.api.ride.common.MonitoredValue;
1873
- otherVentilation?: com.moxi.api.ride.common.MonitoredValue;
1874
- oxygen?: com.moxi.api.ride.common.MonitoredValue;
1875
- pacemaker?: boolean;
1876
- patientWeightAbove100Kg?: boolean;
1877
- peep?: boolean;
1878
- perfusor?: com.moxi.api.ride.common.MonitoredValue;
1879
- powerSupply?: boolean;
1880
- remark?: string;
1881
- resources?: string;
1882
- simvAsb?: boolean;
1883
- sleepy?: boolean;
1884
- spontaneous?: boolean;
1885
- stable?: boolean;
1886
- standardMonitoring?: boolean;
1887
- thoraxDrainage?: boolean;
1888
- tracheostomized?: boolean;
1889
- unconscious?: boolean;
1890
- unstable?: boolean;
1891
- vacuumMattress?: boolean;
1892
- veinCatheter?: boolean;
1893
- ventilated?: boolean;
1894
- }
1895
-
1896
- }
1897
-
1898
- export namespace com.moxi.api.ride.common {
1899
-
1900
- export interface MonitoredValue {
1901
- enabled?: boolean;
1902
- value?: string;
1903
- }
1904
-
1905
- }
1906
-
1907
1774
  export namespace com.moxi.api.ride.common {
1908
1775
 
1909
1776
  export interface Person {
@@ -1923,7 +1790,7 @@ export namespace com.moxi.api.ride.common {
1923
1790
  export namespace com.moxi.api.ride.common {
1924
1791
 
1925
1792
  /**
1926
- * Filled if (and only if) patient exceeds 130 kg
1793
+ * Mandatory if weight exceeds 130 kg, otherwise forbidden
1927
1794
  */
1928
1795
  export interface PersonDimensions {
1929
1796
  heightInCm?: number;
@@ -1933,17 +1800,6 @@ export namespace com.moxi.api.ride.common {
1933
1800
 
1934
1801
  }
1935
1802
 
1936
- export namespace com.moxi.api.ride.common {
1937
-
1938
- /**
1939
- * Ride information specific for regular taxi or ambulance rides.
1940
- */
1941
- export interface RegularRideInfo extends com.moxi.api.ride.common.RideInfo {
1942
- vehicleType: "taxi";
1943
- }
1944
-
1945
- }
1946
-
1947
1803
  export namespace com.moxi.api.ride.common {
1948
1804
 
1949
1805
  export interface Review {
@@ -1957,18 +1813,18 @@ export namespace com.moxi.api.ride.common {
1957
1813
 
1958
1814
  export interface Ride extends com.moxi.api.rideseries.combined.common.RideOrSeries, com.moxi.api.rideseries.combined.common.RideOrMinimizedSeries {
1959
1815
  /**
1960
- * Derived from driver != null
1816
+ * 'accepted' is true if a driver has accepted the ride.
1961
1817
  */
1962
1818
  accepted?: boolean;
1963
1819
  acceptedTime?: string;
1964
1820
  actualEndTime?: string;
1965
1821
  actualStartTime?: string;
1966
1822
  /**
1967
- * Derived from driveStatus != null
1823
+ * 'arrived' is true if the driver has reported driveStatus is 'arrived_at_origin'.
1968
1824
  */
1969
1825
  arrived?: boolean;
1970
1826
  /**
1971
- * Derived from bookedTime != null
1827
+ * 'booked' is false if the ride has only been saved.
1972
1828
  */
1973
1829
  booked?: boolean;
1974
1830
  booker?: com.moxi.api.permissions.common.AccountOrTeamRef;
@@ -1976,15 +1832,15 @@ export namespace com.moxi.api.ride.common {
1976
1832
  cancelReason?: string;
1977
1833
  cancelled?: boolean;
1978
1834
  /**
1979
- * Derived from driveStatus == completed
1835
+ * 'completed' is true if the driver has reported driveStatus is 'completed'.
1980
1836
  */
1981
1837
  completed?: boolean;
1982
1838
  /**
1983
- * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1839
+ * The booker determines the desiredEndTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'to' or 'drop-off' location.
1984
1840
  */
1985
1841
  desiredEndTime?: string;
1986
1842
  /**
1987
- * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1843
+ * The booker determines the desiredStartTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'from' or 'pick-up' location.
1988
1844
  */
1989
1845
  desiredStartTime?: string;
1990
1846
  driveStatus?: com.moxi.api.ride.common.DriveStatus;
@@ -1992,20 +1848,20 @@ export namespace com.moxi.api.ride.common {
1992
1848
  driverSyncStatus?: com.moxi.api.ride.common.SyncStatus;
1993
1849
  endTimeDelay?: number;
1994
1850
  /**
1995
- * Expected Time of Arrival at the Destination/Drop-off location.
1851
+ * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'to' or 'drop-off' location.
1996
1852
  */
1997
1853
  expectedEndTime?: string;
1998
1854
  /**
1999
- * Expected Time of Arrival at the Origin/Pick-up location.
1855
+ * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'from' or 'pick-up' location.
2000
1856
  */
2001
1857
  expectedStartTime?: string;
2002
- info?: com.moxi.api.ride.common.RideInfoUnion;
1858
+ info?: com.moxi.api.ride.common.RideInfo;
2003
1859
  /**
2004
- * Derived from plannedStartTime != null
1860
+ * 'planned' is true if the driver has reported a planned time for the ride.
2005
1861
  */
2006
1862
  planned?: boolean;
2007
1863
  /**
2008
- * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
1864
+ * The driver determines the plannedEndTime. It means the planned time of arrival at the 'to' or 'drop-off' location.
2009
1865
  */
2010
1866
  plannedEndTime?: string;
2011
1867
  plannedStartTime?: string;
@@ -2013,7 +1869,7 @@ export namespace com.moxi.api.ride.common {
2013
1869
  seriesInfo?: com.moxi.api.ride.common.SeriesInfo;
2014
1870
  startTimeDelay?: number;
2015
1871
  /**
2016
- * Derived from driveStatus != null
1872
+ * 'started' is true if the driver has reported a driveStatus.
2017
1873
  */
2018
1874
  started?: boolean;
2019
1875
  }
@@ -2022,13 +1878,19 @@ export namespace com.moxi.api.ride.common {
2022
1878
 
2023
1879
  export namespace com.moxi.api.ride.common {
2024
1880
 
2025
- /**
2026
- * All durations in seconds
2027
- */
2028
1881
  export interface RideDuration {
2029
1882
  driving?: number;
1883
+ /**
1884
+ * Seconds of slack for dropping off the patient, currently hardcoded to 15 minutes
1885
+ */
2030
1886
  droppingOff?: number;
1887
+ /**
1888
+ * Seconds of slack for picking up the patient, currently hardcoded to 15 minutes
1889
+ */
2031
1890
  pickingUp?: number;
1891
+ /**
1892
+ * Seconds of driving time plus the pick-up and drop-off slack times
1893
+ */
2032
1894
  total?: number;
2033
1895
  }
2034
1896
 
@@ -2091,14 +1953,16 @@ export namespace com.moxi.api.ride.common {
2091
1953
 
2092
1954
  export namespace com.moxi.api.ride.common {
2093
1955
 
2094
- /**
2095
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
2096
-
2097
- */
2098
- export interface RideInfo extends com.moxi.api.rideseries.common.GenericRideInfo<com.moxi.api.ride.common.RideInfoUnion> {
1956
+ export interface RideInfo extends com.moxi.api.rideseries.common.GenericRideInfo<com.moxi.api.ride.common.RideInfo> {
2099
1957
  appointment?: com.moxi.api.ride.common.Appointment;
2100
1958
  purpose?: com.moxi.api.ride.common.RidePurpose;
2101
- vehicleType: "intensiveCareAmbulance" | "taxi";
1959
+ }
1960
+
1961
+ }
1962
+
1963
+ export namespace com.moxi.api.ride.common.RideInfo {
1964
+
1965
+ export interface AnonymizedRideInfo extends com.moxi.api.ride.common.RideInfo {
2102
1966
  }
2103
1967
 
2104
1968
  }
@@ -2126,7 +1990,7 @@ export namespace com.moxi.api.ride.common {
2126
1990
  export namespace com.moxi.api.ride.common {
2127
1991
 
2128
1992
  /**
2129
- * Information about a ride that is part of series.
1993
+ * If the ride is part of a series, seriesInfo will contain context about the position of the ride within the series.
2130
1994
  */
2131
1995
  export interface SeriesInfo {
2132
1996
  desyncedFromSeries?: boolean;
@@ -2425,10 +2289,6 @@ export namespace com.moxi.api.rideseries.combined.common {
2425
2289
 
2426
2290
  export namespace com.moxi.api.rideseries.common {
2427
2291
 
2428
- /**
2429
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
2430
-
2431
- */
2432
2292
  export interface GenericRideInfo<T> {
2433
2293
  ambulanceInfo?: com.moxi.api.ride.common.AmbulanceInfo;
2434
2294
  attendantsPresent?: number;
@@ -2454,7 +2314,7 @@ export namespace com.moxi.api.rideseries.common {
2454
2314
  export namespace com.moxi.api.rideseries.common {
2455
2315
 
2456
2316
  /**
2457
- * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
2317
+ * A series of rides.
2458
2318
  */
2459
2319
  export interface MinimizedRideSeries extends com.moxi.api.rideseries.common.RideSeries, com.moxi.api.rideseries.combined.common.RideOrMinimizedSeries {
2460
2320
  info?: com.moxi.api.rideseries.common.SeriesRideInfo;
@@ -2465,17 +2325,20 @@ export namespace com.moxi.api.rideseries.common {
2465
2325
  export namespace com.moxi.api.rideseries.common {
2466
2326
 
2467
2327
  /**
2468
- * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
2328
+ * A series of rides.
2469
2329
  */
2470
2330
  export interface RideSeries extends com.moxi.api.rideseries.combined.common.RideOrSeries {
2471
2331
  /**
2472
- * Derived from driver != null
2332
+ * 'accepted' is true if a driver has accepted the series.
2473
2333
  */
2474
2334
  accepted?: boolean;
2475
2335
  acceptedTime?: string;
2336
+ /**
2337
+ * The number of rides in the series that are not cancelled.
2338
+ */
2476
2339
  activeRideCount?: number;
2477
2340
  /**
2478
- * Derived from bookedTime != null
2341
+ * 'booked' is false if the series has only been saved.
2479
2342
  */
2480
2343
  booked?: boolean;
2481
2344
  booker?: com.moxi.api.permissions.common.AccountOrTeamRef;
@@ -2485,7 +2348,13 @@ export namespace com.moxi.api.rideseries.common {
2485
2348
  rideSeriesId?: string;
2486
2349
  rides?: com.moxi.api.ride.common.Ride[];
2487
2350
  ridesSummaries?: com.moxi.api.rideseries.common.RideSummary[];
2351
+ /**
2352
+ * searchEndTime is the time from which series can be found in our system. It's the searchEndTime of the last ride in the series.
2353
+ */
2488
2354
  searchEndTime?: string;
2355
+ /**
2356
+ * searchStartTime is the time from which series can be found in our system. It's the searchStartTime of the first ride in the series.
2357
+ */
2489
2358
  searchStartTime?: string;
2490
2359
  }
2491
2360
 
@@ -2502,7 +2371,7 @@ export namespace com.moxi.api.rideseries.common {
2502
2371
  export namespace com.moxi.api.rideseries.common {
2503
2372
 
2504
2373
  /**
2505
- * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
2374
+ * Individual ride timing within a series. Once a ride series is accepted, you cannot add rides, only remove
2506
2375
  */
2507
2376
  export interface RideSummary {
2508
2377
  appointmentTime?: string;
@@ -2514,10 +2383,6 @@ export namespace com.moxi.api.rideseries.common {
2514
2383
 
2515
2384
  export namespace com.moxi.api.rideseries.common {
2516
2385
 
2517
- /**
2518
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
2519
-
2520
- */
2521
2386
  export interface SeriesRideInfo extends com.moxi.api.rideseries.common.GenericRideInfo<com.moxi.api.rideseries.common.SeriesRideInfo> {
2522
2387
  purpose?: com.moxi.api.rideseries.common.SeriesPurpose;
2523
2388
  }
@@ -2526,10 +2391,6 @@ export namespace com.moxi.api.rideseries.common {
2526
2391
 
2527
2392
  export namespace com.moxi.api.rideseries.common.SeriesRideInfo {
2528
2393
 
2529
- /**
2530
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
2531
-
2532
- */
2533
2394
  export interface AnonymizedSeriesRideInfo extends com.moxi.api.rideseries.common.SeriesRideInfo {
2534
2395
  }
2535
2396
 
@@ -3055,12 +2916,6 @@ export namespace com.moxi.api.geojson.common.GeoJson {
3055
2916
 
3056
2917
  }
3057
2918
 
3058
- export namespace com.moxi.api.grpc.common {
3059
-
3060
- export type GrpcStreamType = "get_einsatz_events";
3061
-
3062
- }
3063
-
3064
2919
  export namespace com.moxi.api.integrations.common {
3065
2920
 
3066
2921
  export type IntegrationType = "dispolive" | "celios";
@@ -3087,7 +2942,7 @@ export namespace com.moxi.api.permissions.common {
3087
2942
 
3088
2943
  export namespace com.moxi.api.permissions.drive.common {
3089
2944
 
3090
- export type DrivePermissionFilterUnion = com.moxi.api.permissions.drive.common.AmbulanceFilter | com.moxi.api.permissions.drive.common.TaxiFilter | com.moxi.api.permissions.drive.common.IntensiveCareAmbulanceFilter | com.moxi.api.permissions.drive.common.IntensiveCareHelicopterFilter | com.moxi.api.permissions.drive.common.EmergencyAmbulanceFilter;
2945
+ export type DrivePermissionFilterUnion = com.moxi.api.permissions.drive.common.AmbulanceFilter | com.moxi.api.permissions.drive.common.TaxiFilter;
3091
2946
 
3092
2947
  }
3093
2948
 
@@ -3133,12 +2988,6 @@ export namespace com.moxi.api.ride.common {
3133
2988
 
3134
2989
  }
3135
2990
 
3136
- export namespace com.moxi.api.ride.common {
3137
-
3138
- export type RideInfoUnion = com.moxi.api.ride.common.RegularRideInfo | com.moxi.api.ride.common.IntensiveCareRideInfo;
3139
-
3140
- }
3141
-
3142
2991
  export namespace com.moxi.api.ride.common {
3143
2992
 
3144
2993
  export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
@@ -3153,7 +3002,7 @@ export namespace com.moxi.api.ride.common {
3153
3002
 
3154
3003
  export namespace com.moxi.api.ride.common {
3155
3004
 
3156
- export type VehicleType = "taxi" | "ambulance" | "intensiveCareAmbulance" | "intensiveCareHelicopter" | "emergencyAmbulance";
3005
+ export type VehicleType = "taxi" | "ambulance";
3157
3006
 
3158
3007
  }
3159
3008
 
package/common.d.ts CHANGED
@@ -127,14 +127,11 @@ export interface AddOperations extends AccountUpdate {
127
127
  operateAccount?: string;
128
128
  }
129
129
 
130
- /**
131
- * Address info of a google-validated address, including geolocation and district code
132
- */
133
130
  export interface AddressInfo {
134
131
  addition?: string;
135
132
  city?: string;
136
133
  /**
137
- * Derived from districtNutsCode
134
+ * The NUTS country code, derived from districtNutsCode
138
135
  */
139
136
  country?: string;
140
137
  districtNutsCode?: string;
@@ -143,12 +140,12 @@ export interface AddressInfo {
143
140
  number?: string;
144
141
  placeName?: string;
145
142
  /**
146
- * Derived from districtNutsCode
143
+ * The NUTS level 1 code, derived from districtNutsCode
147
144
  */
148
145
  state?: string;
149
146
  street?: string;
150
147
  /**
151
- * Derived from districtNutsCode
148
+ * The NUTS level 2 code, derived from districtNutsCode
152
149
  */
153
150
  subState?: string;
154
151
  zipCode?: string;
@@ -168,31 +165,30 @@ export interface AmbulanceFilter extends DrivePermissionFilter {
168
165
  }
169
166
 
170
167
  /**
171
- * Filled if (and only if) vehicleType == ambulance
168
+ * Mandatory if the vehicleType is ambulance, forbidden if taxi
172
169
  */
173
170
  export interface AmbulanceInfo {
174
171
  /**
175
- * Derived from infectionDescription != blank
172
+ * True if infectionDescription is given
176
173
  */
177
174
  hasInfection?: boolean;
178
175
  infectionDescription?: string;
179
176
  monitoringDescription?: string;
180
177
  oxygenLiterPerHour?: number;
181
178
  /**
182
- * Derived from monitoringDescription != blank
179
+ * True if monitoringDescription is given
183
180
  */
184
181
  requiresMonitoring?: boolean;
185
182
  /**
186
- * Derived from oxygenLiterPerHour != null
183
+ * True if oxygenLiterPerHour is given
187
184
  */
188
185
  requiresOxygen?: boolean;
189
186
  requiresSuctionAspirator?: boolean;
190
187
  }
191
188
 
192
- /**
193
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
189
+ export interface AnonymizedRideInfo extends RideInfo {
190
+ }
194
191
 
195
- */
196
192
  export interface AnonymizedSeriesRideInfo extends SeriesRideInfo {
197
193
  }
198
194
 
@@ -236,14 +232,14 @@ export interface AuthenticationService {
236
232
  }
237
233
 
238
234
  export interface BookRide extends CreateRideCommand {
239
- info?: RideInfoUnion;
235
+ info?: RideInfo;
240
236
  }
241
237
 
242
238
  export interface BookRideSeries extends CreateSeriesCommand {
243
239
  rideSummaries?: RideSummary[];
244
240
  }
245
241
 
246
- export interface CancelRide extends RideCommand {
242
+ export interface CancelRide extends RideBookerCommand {
247
243
  reason?: string;
248
244
  }
249
245
 
@@ -265,11 +261,6 @@ export interface CeliosSettings {
265
261
  user?: string;
266
262
  }
267
263
 
268
- export interface CeliosStreamPulse {
269
- target?: string;
270
- type?: GrpcStreamType;
271
- }
272
-
273
264
  export interface ChangeUserPassword {
274
265
  newPassword?: string;
275
266
  oldPassword?: string;
@@ -431,7 +422,7 @@ export interface DrivePermission {
431
422
  }
432
423
 
433
424
  export interface DrivePermissionFilter {
434
- type: "ambulance" | "emergencyAmbulance" | "intensiveCareAmbulance" | "intensiveCareHelicopter" | "taxi";
425
+ type: "ambulance" | "taxi";
435
426
  }
436
427
 
437
428
  export interface DrivePermissionInfo {
@@ -457,10 +448,6 @@ export interface EmailMessage {
457
448
  tos?: string[];
458
449
  }
459
450
 
460
- export interface EmergencyAmbulanceFilter extends DrivePermissionFilter {
461
- type: "emergencyAmbulance";
462
- }
463
-
464
451
  export interface EuropeanHealthInsurance {
465
452
  acronym?: string;
466
453
  email?: string;
@@ -604,10 +591,6 @@ export interface GenerateTokenResult {
604
591
  jwt?: string;
605
592
  }
606
593
 
607
- /**
608
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
609
-
610
- */
611
594
  export interface GenericRideInfo {
612
595
  ambulanceInfo?: AmbulanceInfo;
613
596
  attendantsPresent?: number;
@@ -816,11 +799,6 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
816
799
  teamPermission?: TeamPermission;
817
800
  }
818
801
 
819
- export interface GrpcStreamId {
820
- target?: string;
821
- type?: GrpcStreamType;
822
- }
823
-
824
802
  export interface HalfHourBeforeStart {
825
803
  rideId?: string;
826
804
  }
@@ -852,23 +830,6 @@ export interface Insurer {
852
830
  name?: string;
853
831
  }
854
832
 
855
- export interface IntensiveCareAmbulanceFilter extends DrivePermissionFilter {
856
- type: "intensiveCareAmbulance";
857
- }
858
-
859
- export interface IntensiveCareHelicopterFilter extends DrivePermissionFilter {
860
- type: "intensiveCareHelicopter";
861
- }
862
-
863
- /**
864
- * Ride information specific for intensive care rides.
865
- */
866
- export interface IntensiveCareRideInfo extends RideInfo {
867
- medicalData?: MedicalData;
868
- patientMedicalCondition?: string;
869
- vehicleType: "intensiveCareAmbulance" | "emergencyAmbulance" | "intensiveCareHelicopter";
870
- }
871
-
872
833
  export interface Invite {
873
834
  accountId?: string;
874
835
  invitedBy?: string;
@@ -900,50 +861,6 @@ export interface MarketplaceOverviewFilter extends WebsocketFilter {
900
861
  screen: "marketplace";
901
862
  }
902
863
 
903
- export interface MedicalData {
904
- activeSubstances?: MonitoredValue;
905
- administrativeJourney?: string;
906
- alarmNumber?: number;
907
- analogueSedated?: boolean;
908
- catecholamines?: boolean;
909
- cpapAsb?: boolean;
910
- dkvBipap?: boolean;
911
- ecmo?: boolean;
912
- fio2AboveZeroPointFive?: boolean;
913
- highFlowOxygenTherapy?: boolean;
914
- iabp?: boolean;
915
- ibpMonitoring?: boolean;
916
- incubator?: boolean;
917
- infection?: MonitoredValue;
918
- infusomats?: MonitoredValue;
919
- intubated?: boolean;
920
- ippvCppv?: boolean;
921
- niv?: boolean;
922
- oriented?: boolean;
923
- otherMonitoring?: MonitoredValue;
924
- otherVentilation?: MonitoredValue;
925
- oxygen?: MonitoredValue;
926
- pacemaker?: boolean;
927
- patientWeightAbove100Kg?: boolean;
928
- peep?: boolean;
929
- perfusor?: MonitoredValue;
930
- powerSupply?: boolean;
931
- remark?: string;
932
- resources?: string;
933
- simvAsb?: boolean;
934
- sleepy?: boolean;
935
- spontaneous?: boolean;
936
- stable?: boolean;
937
- standardMonitoring?: boolean;
938
- thoraxDrainage?: boolean;
939
- tracheostomized?: boolean;
940
- unconscious?: boolean;
941
- unstable?: boolean;
942
- vacuumMattress?: boolean;
943
- veinCatheter?: boolean;
944
- ventilated?: boolean;
945
- }
946
-
947
864
  export interface Metric {
948
865
  clientId?: string;
949
866
  clientSegment?: number[];
@@ -955,17 +872,12 @@ export interface Metric {
955
872
  }
956
873
 
957
874
  /**
958
- * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
875
+ * A series of rides.
959
876
  */
960
877
  export interface MinimizedRideSeries extends RideSeries, RideOrMinimizedSeries {
961
878
  info?: SeriesRideInfo;
962
879
  }
963
880
 
964
- export interface MonitoredValue {
965
- enabled?: boolean;
966
- value?: string;
967
- }
968
-
969
881
  export interface Notification {
970
882
  body?: string;
971
883
  title?: string;
@@ -1028,7 +940,7 @@ export interface Person {
1028
940
  }
1029
941
 
1030
942
  /**
1031
- * Filled if (and only if) patient exceeds 130 kg
943
+ * Mandatory if weight exceeds 130 kg, otherwise forbidden
1032
944
  */
1033
945
  export interface PersonDimensions {
1034
946
  heightInCm?: number;
@@ -1095,13 +1007,6 @@ export interface RegisterOneTimePassword {
1095
1007
  userId?: string;
1096
1008
  }
1097
1009
 
1098
- /**
1099
- * Ride information specific for regular taxi or ambulance rides.
1100
- */
1101
- export interface RegularRideInfo extends RideInfo {
1102
- vehicleType: "taxi" | "ambulance";
1103
- }
1104
-
1105
1010
  export interface RemoveAccount extends AccountUpdate {
1106
1011
  }
1107
1012
 
@@ -1201,18 +1106,18 @@ export interface RevokeUserRefreshTokens {
1201
1106
 
1202
1107
  export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
1203
1108
  /**
1204
- * Derived from driver != null
1109
+ * 'accepted' is true if a driver has accepted the ride.
1205
1110
  */
1206
1111
  accepted?: boolean;
1207
1112
  acceptedTime?: string;
1208
1113
  actualEndTime?: string;
1209
1114
  actualStartTime?: string;
1210
1115
  /**
1211
- * Derived from driveStatus != null
1116
+ * 'arrived' is true if the driver has reported driveStatus is 'arrived_at_origin'.
1212
1117
  */
1213
1118
  arrived?: boolean;
1214
1119
  /**
1215
- * Derived from bookedTime != null
1120
+ * 'booked' is false if the ride has only been saved.
1216
1121
  */
1217
1122
  booked?: boolean;
1218
1123
  booker?: AccountOrTeamRef;
@@ -1220,15 +1125,15 @@ export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
1220
1125
  cancelReason?: string;
1221
1126
  cancelled?: boolean;
1222
1127
  /**
1223
- * Derived from driveStatus == completed
1128
+ * 'completed' is true if the driver has reported driveStatus is 'completed'.
1224
1129
  */
1225
1130
  completed?: boolean;
1226
1131
  /**
1227
- * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1132
+ * The booker determines the desiredEndTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'to' or 'drop-off' location.
1228
1133
  */
1229
1134
  desiredEndTime?: string;
1230
1135
  /**
1231
- * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1136
+ * The booker determines the desiredStartTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'from' or 'pick-up' location.
1232
1137
  */
1233
1138
  desiredStartTime?: string;
1234
1139
  driveStatus?: DriveStatus;
@@ -1236,20 +1141,20 @@ export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
1236
1141
  driverSyncStatus?: SyncStatus;
1237
1142
  endTimeDelay?: number;
1238
1143
  /**
1239
- * Expected Time of Arrival at the Destination/Drop-off location.
1144
+ * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'to' or 'drop-off' location.
1240
1145
  */
1241
1146
  expectedEndTime?: string;
1242
1147
  /**
1243
- * Expected Time of Arrival at the Origin/Pick-up location.
1148
+ * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'from' or 'pick-up' location.
1244
1149
  */
1245
1150
  expectedStartTime?: string;
1246
- info?: RideInfoUnion;
1151
+ info?: RideInfo;
1247
1152
  /**
1248
- * Derived from plannedStartTime != null
1153
+ * 'planned' is true if the driver has reported a planned time for the ride.
1249
1154
  */
1250
1155
  planned?: boolean;
1251
1156
  /**
1252
- * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
1157
+ * The driver determines the plannedEndTime. It means the planned time of arrival at the 'to' or 'drop-off' location.
1253
1158
  */
1254
1159
  plannedEndTime?: string;
1255
1160
  plannedStartTime?: string;
@@ -1257,7 +1162,7 @@ export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
1257
1162
  seriesInfo?: SeriesInfo;
1258
1163
  startTimeDelay?: number;
1259
1164
  /**
1260
- * Derived from driveStatus != null
1165
+ * 'started' is true if the driver has reported a driveStatus.
1261
1166
  */
1262
1167
  started?: boolean;
1263
1168
  }
@@ -1275,13 +1180,19 @@ export interface RideDriverCommand extends RideCommand {
1275
1180
  export interface RideDriverModifyCommand extends RideDriverCommand {
1276
1181
  }
1277
1182
 
1278
- /**
1279
- * All durations in seconds
1280
- */
1281
1183
  export interface RideDuration {
1282
1184
  driving?: number;
1185
+ /**
1186
+ * Seconds of slack for dropping off the patient, currently hardcoded to 15 minutes
1187
+ */
1283
1188
  droppingOff?: number;
1189
+ /**
1190
+ * Seconds of slack for picking up the patient, currently hardcoded to 15 minutes
1191
+ */
1284
1192
  pickingUp?: number;
1193
+ /**
1194
+ * Seconds of driving time plus the pick-up and drop-off slack times
1195
+ */
1285
1196
  total?: number;
1286
1197
  }
1287
1198
 
@@ -1328,10 +1239,6 @@ export interface RideIdResult {
1328
1239
  rideId?: string;
1329
1240
  }
1330
1241
 
1331
- /**
1332
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
1333
-
1334
- */
1335
1242
  export interface RideInfo extends GenericRideInfo {
1336
1243
  appointment?: Appointment;
1337
1244
  purpose?: RidePurpose;
@@ -1376,17 +1283,20 @@ export interface RideOrSeries {
1376
1283
  }
1377
1284
 
1378
1285
  /**
1379
- * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
1286
+ * A series of rides.
1380
1287
  */
1381
1288
  export interface RideSeries extends RideOrSeries {
1382
1289
  /**
1383
- * Derived from driver != null
1290
+ * 'accepted' is true if a driver has accepted the series.
1384
1291
  */
1385
1292
  accepted?: boolean;
1386
1293
  acceptedTime?: string;
1294
+ /**
1295
+ * The number of rides in the series that are not cancelled.
1296
+ */
1387
1297
  activeRideCount?: number;
1388
1298
  /**
1389
- * Derived from bookedTime != null
1299
+ * 'booked' is false if the series has only been saved.
1390
1300
  */
1391
1301
  booked?: boolean;
1392
1302
  booker?: AccountOrTeamRef;
@@ -1396,7 +1306,13 @@ export interface RideSeries extends RideOrSeries {
1396
1306
  rideSeriesId?: string;
1397
1307
  rides?: Ride[];
1398
1308
  ridesSummaries?: RideSummary[];
1309
+ /**
1310
+ * searchEndTime is the time from which series can be found in our system. It's the searchEndTime of the last ride in the series.
1311
+ */
1399
1312
  searchEndTime?: string;
1313
+ /**
1314
+ * searchStartTime is the time from which series can be found in our system. It's the searchStartTime of the first ride in the series.
1315
+ */
1400
1316
  searchStartTime?: string;
1401
1317
  }
1402
1318
 
@@ -1423,7 +1339,7 @@ export interface RideStatisticsQuery {
1423
1339
  }
1424
1340
 
1425
1341
  /**
1426
- * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
1342
+ * Individual ride timing within a series. Once a ride series is accepted, you cannot add rides, only remove
1427
1343
  */
1428
1344
  export interface RideSummary {
1429
1345
  appointmentTime?: string;
@@ -1454,7 +1370,7 @@ export interface Role {
1454
1370
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
1455
1371
  */
1456
1372
  export interface SaveRide extends CreateRideCommand {
1457
- info?: RideInfoUnion;
1373
+ info?: RideInfo;
1458
1374
  }
1459
1375
 
1460
1376
  export interface SaveRideSeries extends CreateSeriesCommand {
@@ -1517,7 +1433,7 @@ export interface SeriesDriverCommand extends SeriesCommand {
1517
1433
  }
1518
1434
 
1519
1435
  /**
1520
- * Information about a ride that is part of series.
1436
+ * If the ride is part of a series, seriesInfo will contain context about the position of the ride within the series.
1521
1437
  */
1522
1438
  export interface SeriesInfo {
1523
1439
  desyncedFromSeries?: boolean;
@@ -1530,10 +1446,6 @@ export interface SeriesInfo {
1530
1446
  export interface SeriesOperatorCommand extends SeriesCommand {
1531
1447
  }
1532
1448
 
1533
- /**
1534
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
1535
-
1536
- */
1537
1449
  export interface SeriesRideInfo extends GenericRideInfo {
1538
1450
  purpose?: SeriesPurpose;
1539
1451
  }
@@ -1583,16 +1495,6 @@ export interface SignedInUser {
1583
1495
  userId?: string;
1584
1496
  }
1585
1497
 
1586
- export interface StartCeliosStream {
1587
- target?: string;
1588
- type?: GrpcStreamType;
1589
- }
1590
-
1591
- export interface StopCeliosStream {
1592
- target?: string;
1593
- type?: GrpcStreamType;
1594
- }
1595
-
1596
1498
  export interface StopImpersonatingUser {
1597
1499
  }
1598
1500
 
@@ -1682,7 +1584,7 @@ export interface UpdatePosition {
1682
1584
 
1683
1585
  export interface UpdateRide extends RideBookerCommand {
1684
1586
  booker?: AccountOrTeamRef;
1685
- info?: RideInfoUnion;
1587
+ info?: RideInfo;
1686
1588
  }
1687
1589
 
1688
1590
  export interface UpdateRidePlan extends RideDriverModifyCommand {
@@ -1796,7 +1698,7 @@ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "start
1796
1698
 
1797
1699
  export type DocumentType = "businessLicense" | "publicLiabilityPolicy";
1798
1700
 
1799
- export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter | IntensiveCareAmbulanceFilter | IntensiveCareHelicopterFilter | EmergencyAmbulanceFilter;
1701
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1800
1702
 
1801
1703
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1802
1704
 
@@ -1804,8 +1706,6 @@ export type EntityType = "ride" | "rideseries";
1804
1706
 
1805
1707
  export type GeometryUnion = GeoPolygon | GeoMultiPolygon;
1806
1708
 
1807
- export type GrpcStreamType = "get_einsatz_events";
1808
-
1809
1709
  export type InsuranceType = "public_insurance" | "private_insurance" | "german_accident_insurance" | "no_or_unknown_insurance";
1810
1710
 
1811
1711
  export type IntegrationType = "dispolive" | "celios";
@@ -1814,8 +1714,6 @@ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chai
1814
1714
 
1815
1715
  export type OrganisationType = "medical" | "fleet" | "operator";
1816
1716
 
1817
- export type RideInfoUnion = RegularRideInfo | IntensiveCareRideInfo;
1818
-
1819
1717
  export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1820
1718
 
1821
1719
  export type Screen = "ping" | "marketplace" | "operations_overview" | "hospital_overview" | "fleet_overview" | "ride_details";
@@ -1834,7 +1732,7 @@ export type TeamRole = "dispatcher" | "ridebooker";
1834
1732
 
1835
1733
  export type UserRole = "superadmin";
1836
1734
 
1837
- export type VehicleType = "taxi" | "ambulance" | "intensiveCareAmbulance" | "intensiveCareHelicopter" | "emergencyAmbulance";
1735
+ export type VehicleType = "taxi" | "ambulance";
1838
1736
 
1839
1737
  export type WebsocketMessageUnion = MarketplaceOverviewFilter | HospitalOverviewFilter | FleetOverviewFilter | OperationsOverviewFilter | DetailsFilter | WebsocketPing;
1840
1738
 
@@ -206,7 +206,7 @@
206
206
  ]
207
207
  },
208
208
  {
209
- "name" : "Bavaria",
209
+ "name" : "Bayern",
210
210
  "code" : "DE2",
211
211
  "substates" : [
212
212
  {
@@ -946,7 +946,7 @@
946
946
  ]
947
947
  },
948
948
  {
949
- "name" : "Lower Saxony",
949
+ "name" : "Niedersachsen",
950
950
  "code" : "DE9",
951
951
  "substates" : [
952
952
  {
@@ -1156,7 +1156,7 @@
1156
1156
  ]
1157
1157
  },
1158
1158
  {
1159
- "name" : "North Rhine-Westphalia",
1159
+ "name" : "Nordrhein-Westfalen",
1160
1160
  "code" : "DEA",
1161
1161
  "substates" : [
1162
1162
  {
@@ -1404,7 +1404,7 @@
1404
1404
  ]
1405
1405
  },
1406
1406
  {
1407
- "name" : "Rhineland-Palatinate",
1407
+ "name" : "Rheinland-Pfalz",
1408
1408
  "code" : "DEB",
1409
1409
  "substates" : [
1410
1410
  {
@@ -1608,7 +1608,7 @@
1608
1608
  ]
1609
1609
  },
1610
1610
  {
1611
- "name" : "Saxony",
1611
+ "name" : "Sachsen",
1612
1612
  "code" : "DED",
1613
1613
  "substates" : [
1614
1614
  {
@@ -1684,7 +1684,7 @@
1684
1684
  ]
1685
1685
  },
1686
1686
  {
1687
- "name" : "Saxony-Anhalt",
1687
+ "name" : "Sachsen-Anhalt",
1688
1688
  "code" : "DEE",
1689
1689
  "substates" : [
1690
1690
  {
@@ -1824,7 +1824,7 @@
1824
1824
  ]
1825
1825
  },
1826
1826
  {
1827
- "name" : "Thuringia",
1827
+ "name" : "Thüringen",
1828
1828
  "code" : "DEG",
1829
1829
  "substates" : [
1830
1830
  {
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@moxi.gmbh/moxi-typescriptmodels",
3
- "version": "0.1.3011-test-server",
3
+ "version": "0.19.18",
4
4
  "types": "common.d.ts"
5
5
  }