@moxi.gmbh/moxi-typescriptmodels 0.0.1101 → 0.0.1131

package/common.d.ts

@@ -61,18 +61,29 @@ export interface AccountRef {
 export interface AccountUpdate extends AccountCommand {
 }
 
+/**
+ * Address info of a google-validated address, including geolocation and district code
+ */
 export interface AddressInfo {
     addition?: string;
     city?: string;
+    /**
+     * Derived from districtNutsCode
+     */
     country?: string;
-    displayName?: string;
     districtNutsCode?: string;
     geoLocation?: GeoLocation;
     instructions?: string;
     number?: string;
     placeName?: string;
+    /**
+     * Derived from districtNutsCode
+     */
     state?: string;
     street?: string;
+    /**
+     * Derived from districtNutsCode
+     */
     subState?: string;
     zipCode?: string;
 }
@@ -97,12 +108,24 @@ export interface AmbulanceFilter extends RideTypeSpecificFilter {
     type: "ambulance";
 }
 
+/**
+ * Filled if (and only if) rideType == ambulance
+ */
 export interface AmbulanceInfo {
+    /**
+     * Derived from infectionDescription != blank
+     */
     hasInfection?: boolean;
     infectionDescription?: string;
     monitoringDescription?: string;
     oxygenLiterPerHour?: number;
+    /**
+     * Derived from monitoringDescription != blank
+     */
     requiresMonitoring?: boolean;
+    /**
+     * Derived from oxygenLiterPerHour != null
+     */
     requiresOxygen?: boolean;
     requiresSuctionAspirator?: boolean;
 }
@@ -512,6 +535,9 @@ export interface Person {
     phoneNumber?: string;
 }
 
+/**
+ * Filled if (and only if) patient exceeds 130 kg
+ */
 export interface PersonDimensions {
     heightInCm?: number;
     hipWidthInCm?: number;
@@ -593,21 +619,45 @@ export interface RevokeSubscription extends AccountUpdate {
 }
 
 export interface Ride {
+    /**
+     * Derived from driveOwner != null
+     */
     accepted?: boolean;
+    /**
+     * Derived from bookedTime != null
+     */
     booked?: boolean;
     bookedTime?: string;
     bookingStatus?: BookingStatus;
     cancelled?: boolean;
+    /**
+     * Derived from driveStatus == completed
+     */
     completed?: boolean;
+    /**
+     * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
+     */
     destinationEta?: string;
+    /**
+     * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
+     */
     destinationPta?: string;
     driveOwner?: AccountOrTeamRef;
     driveStatus?: DriveStatus;
     info?: RideInfo;
+    /**
+     * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
+     */
     originEta?: string;
+    /**
+     * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
+     */
     originPta?: string;
     rideId?: string;
     rideOwner?: AccountOrTeamRef;
+    /**
+     * Derived from driveStatus != null
+     */
     started?: boolean;
 }
 
@@ -642,6 +692,9 @@ export interface RideFilterCount {
     total?: number;
 }
 
+/**
+ * Information about the ride, from the creator of the ride
+ */
 export interface RideInfo {
     ambulanceInfo?: AmbulanceInfo;
     appointment?: Appointment;
@@ -650,6 +703,9 @@ export interface RideInfo {
     direction?: Direction;
     distanceInMeters?: number;
     from?: AddressInfo;
+    /**
+     * Derived from weightInKg != null
+     */
     heavyWeight?: boolean;
     mobility?: Mobility;
     patient?: Person;
@@ -691,6 +747,9 @@ export interface RoleRight extends Right {
     type: "role";
 }
 
+/**
+ * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked. 
+ */
 export interface SaveRide extends CreateRideCommand {
     info?: RideInfo;
     owner?: AccountOrTeamRef;

package/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@moxi.gmbh/moxi-typescriptmodels",
-  "version": "0.0.1101",
+  "version": "0.0.1131",
   "types": "common.d.ts"
 }