@moxi.gmbh/moxi-typescriptmodels 0.1.1121-test-server → 0.1.1121

package/common.d.ts

@@ -1,10 +1,44 @@
 
+export interface AbstractFindMyRides {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
+}
+
+export interface AbstractFindRides {
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
+}
+
+export interface AbstractFindRidesForDriver {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
+}
+
+export interface AbstractFindRidesInMarketplace {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    /**
+     * @deprecated
+     */
+    maxSize?: number;
+    term?: string;
+}
+
 export interface AcceptRide extends RideDriverCommand {
     driver?: AccountOrTeamRef;
 }
 
-export interface AcceptRideSeries extends RideDriverSeriesCommand {
-    dispatcher?: AccountOrTeamRef;
+export interface AcceptRideSeries extends SeriesDriverCommand {
+    driver?: AccountOrTeamRef;
 }
 
 export interface AcceptUserAgreement extends UserEdit {
@@ -26,6 +60,12 @@ export interface Account {
     drivePermissions?: DrivePermission[];
     info?: AccountInfo;
     integrationSettings?: any[];
+    operateAccounts?: string[];
+    operators?: string[];
+    /**
+     * Derived from subscriptions. Includes organisation types that have not been confirmed yet by a superadmin or are active in past or future. 
+     */
+    organisationTypes?: OrganisationType[];
     subscriptions?: Subscription[];
     teams?: Team[];
     unconfirmedCriticalInfo?: CriticalAccountInfo;
@@ -67,6 +107,10 @@ export interface AccountPermissionCommand extends UserUpdate {
     accountId?: string;
 }
 
+export interface AccountPermissionFilter {
+    roles?: AccountRole[];
+}
+
 export interface AccountRef {
     accountId?: string;
     name?: string;
@@ -78,14 +122,15 @@ export interface AccountUpcaster {
 export interface AccountUpdate extends AccountCommand {
 }
 
-/**
- * Address info of a google-validated address, including geolocation and district code
- */
+export interface AddOperations extends AccountUpdate {
+    operateAccount?: string;
+}
+
 export interface AddressInfo {
     addition?: string;
     city?: string;
     /**
-     * Derived from districtNutsCode
+     * The NUTS country code, derived from districtNutsCode
      */
     country?: string;
     districtNutsCode?: string;
@@ -94,12 +139,12 @@ export interface AddressInfo {
     number?: string;
     placeName?: string;
     /**
-     * Derived from districtNutsCode
+     * The NUTS level 1 code, derived from districtNutsCode
      */
     state?: string;
     street?: string;
     /**
-     * Derived from districtNutsCode
+     * The NUTS level 2 code, derived from districtNutsCode
      */
     subState?: string;
     zipCode?: string;
@@ -119,37 +164,31 @@ export interface AmbulanceFilter extends DrivePermissionFilter {
 }
 
 /**
- * Filled if (and only if) vehicleType == ambulance
+ * Mandatory if the vehicleType is ambulance, forbidden if taxi
  */
 export interface AmbulanceInfo {
     /**
-     * Derived from infectionDescription != blank
+     * True if infectionDescription is given
      */
     hasInfection?: boolean;
     infectionDescription?: string;
     monitoringDescription?: string;
     oxygenLiterPerHour?: number;
     /**
-     * Derived from monitoringDescription != blank
+     * True if monitoringDescription is given
      */
     requiresMonitoring?: boolean;
     /**
-     * Derived from oxygenLiterPerHour != null
+     * True if oxygenLiterPerHour is given
      */
     requiresOxygen?: boolean;
     requiresSuctionAspirator?: boolean;
 }
 
-/**
- * Same as RideInfo, except it does not contain an appointment
- */
-export interface AnonymizedGenericRideInfo extends GenericRideInfo {
+export interface AnonymizedRideInfo extends RideInfo {
 }
 
-/**
- * Information about the ride, from the creator of the ride
- */
-export interface AnonymizedRideInfo extends RideInfo {
+export interface AnonymizedSeriesRideInfo extends SeriesRideInfo {
 }
 
 export interface Appointment {
@@ -157,7 +196,11 @@ export interface Appointment {
     time?: string;
 }
 
-export interface AssignDriver extends RideCommand {
+export interface AssignDriver extends RideOperatorCommand {
+    driver?: AccountOrTeamRef;
+}
+
+export interface AssignRideSeriesDriver extends SeriesOperatorCommand {
     driver?: AccountOrTeamRef;
 }
 
@@ -179,39 +222,31 @@ export interface AuthenticationResponse {
     userProfile?: UserProfile;
 }
 
-export interface AuthenticationService {
+export interface AuthenticationResponseFactory {
 }
 
-export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
-    info?: GenericRideInfo;
-    updater?: AccountOrTeamRef;
-}
-
-export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
-    rides?: SingleRideUpdate[];
-    updater?: AccountOrTeamRef;
+export interface AuthenticationService {
 }
 
 export interface BookRide extends CreateRideCommand {
-    booker?: AccountOrTeamRef;
     info?: RideInfo;
 }
 
-export interface BookRideSeries extends RideBookerSeriesCommand {
-    booker?: AccountOrTeamRef;
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
+export interface BookRideSeries extends CreateSeriesCommand {
+    rideSummaries?: RideSummary[];
 }
 
 export interface CancelRide extends RideBookerCommand {
     reason?: string;
 }
 
-export interface CancelRideSeries extends RideBookerSeriesCommand {
+export interface CancelRideSeries extends SeriesCommandWithSeparateEvent {
+    reason?: string;
 }
 
-export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
-    updater?: AccountOrTeamRef;
+export interface CancelRideSeriesEvent extends SeriesBookerCommand {
+    cancelRides?: string[];
+    reason?: string;
 }
 
 export interface CeliosSettings {
@@ -233,6 +268,20 @@ export interface CheckIfUserSignedUp {
     userId?: string;
 }
 
+export interface CheckSession {
+    userId?: string;
+}
+
+/**
+ * You can send in custom values. For every value you don't send in, we lookup the default setting you set up in your account. 
+ */
+export interface CleaningAndSlack {
+    cleaningAtGarage?: boolean;
+    cleaningDuration?: number;
+    dropoffDuration?: number;
+    pickupDuration?: number;
+}
+
 export interface ConfirmAccount extends AccountCommand {
 }
 
@@ -243,9 +292,6 @@ export interface ConfirmDrivePermission extends AccountUpdate {
 export interface ConfirmEverythingInAccount extends AccountCommand {
 }
 
-export interface ConfirmRideSeries extends RideDriverSeriesCommand {
-}
-
 export interface ConfirmSubscription extends AccountUpdate {
     subscriptionId?: string;
 }
@@ -274,14 +320,12 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
 }
 
 export interface CreateRideCommand extends RideBookerCommand {
-    booker?: AccountOrTeamId;
+    booker?: AccountOrTeamRef;
 }
 
-export interface CreateRideFromSeries extends RideDriverCommand {
+export interface CreateSeriesCommand extends SeriesBookerCommand {
     booker?: AccountOrTeamRef;
-    driver?: AccountOrTeamRef;
-    info?: RideInfo;
-    seriesInfo?: SeriesInfo;
+    info?: SeriesRideInfo;
 }
 
 export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -317,6 +361,11 @@ export interface DateRange {
 export interface DeleteUser extends UserEdit {
 }
 
+export interface DetailsFilter extends WebsocketFilter {
+    id?: string;
+    screen: "ride_details";
+}
+
 export interface DisconnectClient {
     clientId?: string;
     tokenId?: string;
@@ -427,44 +476,25 @@ export interface FindAccounts {
     term?: string;
 }
 
-export interface FindMyAcceptedRides {
+export interface FindDuplicateRides {
     accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+    appointmentTime?: string;
+    patientBirthDay?: string;
+    patientFirstName?: string;
+    patientLastName?: string;
 }
 
-/**
- * @deprecated
- */
-export interface FindMyRideOffers {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMyRides extends AbstractFindMyRides {
 }
 
-export interface FindMyRideSeries {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMyRidesAndSeries extends AbstractFindMyRides {
 }
 
-export interface FindMyRides {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMySeries extends AbstractFindMyRides {
 }
 
 export interface FindMyTokens {
     accountId?: string;
-    teamId?: string;
     term?: string;
 }
 
@@ -474,27 +504,27 @@ export interface FindMyUsers {
     term?: string;
 }
 
-export interface FindPotentialRideSeries {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideInfoFilter;
-    maxSize?: number;
-    timeRange?: InstantRange;
+export interface FindRides extends AbstractFindRides {
 }
 
-export interface FindPotentialRides {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindRidesAndSeries extends AbstractFindRides {
 }
 
-export interface FindRides {
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindRidesAndSeriesForDriver extends AbstractFindRidesForDriver {
+}
+
+export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMarketplace {
+}
+
+export interface FindRidesAndSeriesResult {
+    ridesAndSeries?: RideOrMinimizedSeries[];
+    ridesCount?: RideFilterCount;
+}
+
+export interface FindRidesForDriver extends AbstractFindRidesForDriver {
+}
+
+export interface FindRidesInMarketplace extends AbstractFindRidesInMarketplace {
 }
 
 export interface FindRidesResult {
@@ -502,23 +532,47 @@ export interface FindRidesResult {
     rides?: Ride[];
 }
 
+export interface FindSeries extends AbstractFindRides {
+}
+
+export interface FindSeriesForDriver extends AbstractFindRidesForDriver {
+}
+
+export interface FindSeriesInMarketplace extends AbstractFindRidesInMarketplace {
+}
+
 export interface FindTokens {
     term?: string;
 }
 
 export interface FindUsers {
+    accountFilter?: AccountFilter;
+    accountPermissionFilter?: AccountPermissionFilter;
     term?: string;
 }
 
+export interface FirebaseMessage {
+    data?: { [index: string]: string };
+    notification?: Notification;
+    topic?: string;
+}
+
+export interface FleetOverviewFilter extends WebsocketFilter {
+    queryFilter?: FindRidesAndSeriesForDriver;
+    screen: "fleet_overview";
+}
+
 export interface GenerateToken {
     accountPermission?: AccountPermission;
     info?: TokenInfo;
     tokenId?: string;
 }
 
-/**
- * Same as RideInfo, except it does not contain an appointment
- */
+export interface GenerateTokenResult {
+    entity?: Token;
+    jwt?: string;
+}
+
 export interface GenericRideInfo {
     ambulanceInfo?: AmbulanceInfo;
     attendantsPresent?: number;
@@ -534,7 +588,6 @@ export interface GenericRideInfo {
     patient?: Person;
     plannedDuration?: RideDuration;
     preferredDriver?: string;
-    purpose?: RidePurpose;
     to?: AddressInfo;
     vehicleType?: VehicleType;
     weightInKg?: number;
@@ -570,10 +623,16 @@ export interface GetAccount {
     accountId?: string;
 }
 
-export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
+/**
+ * @deprecated
+ */
+export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
 }
 
-export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
+/**
+ * @deprecated
+ */
+export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
 }
 
 export interface GetDistrict {
@@ -596,32 +655,17 @@ export interface GetIsoStates {
 export interface GetMonopolyAccounts {
 }
 
-export interface GetMyAcceptedRides {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
 export interface GetMyAccounts {
     filter?: AccountFilter;
 }
 
-/**
- * @deprecated
- */
-export interface GetMyRideOffers {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
-export interface GetMyRideSeries {
+export interface GetMyRides {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetMyRides {
+export interface GetMySeries {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
@@ -636,20 +680,27 @@ export interface GetMyUserProfile {
 export interface GetNutsStates {
 }
 
-export interface GetPotentialDrivers {
+export interface GetOneSeries {
+    rideSeriesId?: string;
+}
+
+export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
+}
+
+/**
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
+
+ */
+export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
+}
+
+export interface GetPotentialDriversAbstract {
     fromDistrict?: string;
     mobility?: Mobility;
-    toDistrict?: string;
     vehicleType?: VehicleType;
     weightInKg?: number;
 }
 
-export interface GetPotentialRides {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
 export interface GetRide {
     rideId?: string;
 }
@@ -669,12 +720,38 @@ export interface GetRideLog {
     rideId?: string;
 }
 
-export interface GetRideSeries {
-    rideSeriesId?: string;
+export interface GetRideOrSeries {
+    id?: string;
+}
+
+export interface GetRidesForDriver {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
+}
+
+export interface GetRidesInMarketplace {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
 }
 
 export interface GetRidesInSeries {
-    filter?: RideFilter;
+    rideSeriesId?: string;
+}
+
+export interface GetSeriesForDriver {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
+}
+
+export interface GetSeriesInMarketplace {
+    accountId?: string;
+    maxSize?: number;
+}
+
+export interface GetSeriesLog {
     rideSeriesId?: string;
 }
 
@@ -704,6 +781,23 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
     teamPermission?: TeamPermission;
 }
 
+export interface HalfHourBeforeStart {
+    rideId?: string;
+}
+
+export interface HospitalOverviewFilter extends WebsocketFilter {
+    queryFilter?: FindMyRidesAndSeries;
+    screen: "hospital_overview";
+}
+
+export interface IGetPotentialDrivers {
+    fromDistrict?: string;
+    mobility?: Mobility;
+    toDistrict?: string;
+    vehicleType?: VehicleType;
+    weightInKg?: number;
+}
+
 export interface ImpersonateUser {
     userId?: string;
 }
@@ -744,6 +838,11 @@ export interface IsoState {
     nutsCode?: string;
 }
 
+export interface MarketplaceOverviewFilter extends WebsocketFilter {
+    queryFilter?: FindRidesAndSeriesInMarketplace;
+    screen: "marketplace";
+}
+
 export interface Metric {
     clientId?: string;
     clientSegment?: number[];
@@ -754,6 +853,18 @@ export interface Metric {
     updates?: string[];
 }
 
+/**
+ * A series of rides. 
+ */
+export interface MinimizedRideSeries extends RideSeries, RideOrMinimizedSeries {
+    info?: SeriesRideInfo;
+}
+
+export interface Notification {
+    body?: string;
+    title?: string;
+}
+
 export interface NutsDistrict {
     code?: string;
     name?: string;
@@ -776,6 +887,15 @@ export interface OffsetTimeRange {
     start?: Date;
 }
 
+export interface OneHourAfterEnd {
+    rideId?: string;
+}
+
+export interface OperationsOverviewFilter extends WebsocketFilter {
+    queryFilter?: FindRidesAndSeries;
+    screen: "operations_overview";
+}
+
 export interface OptimizerMessage {
 }
 
@@ -792,7 +912,7 @@ export interface Person {
 }
 
 /**
- * Filled if (and only if) patient exceeds 130 kg
+ * Mandatory if weight exceeds 130 kg, otherwise forbidden
  */
 export interface PersonDimensions {
     heightInCm?: number;
@@ -812,7 +932,7 @@ export interface ReadUpdates {
     maxSize?: number;
     maxTimeout?: number;
     tokenId?: string;
-    updateTypes?: TrackingUpdateType[];
+    updateTypes?: EntityType[];
 }
 
 export interface ReadUpdatesResult {
@@ -821,6 +941,24 @@ export interface ReadUpdatesResult {
     updates?: any[];
 }
 
+export interface RefreshTokenData {
+    expiresAt?: string;
+    hashedToken?: string;
+    userId?: string;
+}
+
+export interface RefreshTokenService {
+}
+
+export interface RefreshUserToken {
+    refreshToken?: string;
+}
+
+export interface RefreshableAuthenticationResponse extends AuthenticationResponse {
+    refreshToken?: string;
+    refreshTokenDeadline?: string;
+}
+
 export interface Region {
     nutsCode?: string;
 }
@@ -844,6 +982,14 @@ export interface RegisterEinsatz {
 export interface RemoveAccount extends AccountUpdate {
 }
 
+export interface RemoveOperations extends AccountUpdate {
+    operateAccount?: string;
+}
+
+export interface RemoveOperator extends AccountUpdate {
+    operator?: string;
+}
+
 export interface RemoveSettings extends AccountUpdate {
     type?: IntegrationType;
 }
@@ -893,7 +1039,7 @@ export interface ResetPosition {
 export interface ReturnRide extends RideDriverModifyCommand {
 }
 
-export interface ReturnRideSeries extends RideDriverSeriesCommand {
+export interface ReturnRideSeries extends SeriesDriverCommand {
 }
 
 export interface Review {
@@ -916,6 +1062,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
     drivePermissionId?: string;
 }
 
+export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
+}
+
 export interface RevokeSubscription extends AccountUpdate {
     subscriptionId?: string;
 }
@@ -923,75 +1072,70 @@ export interface RevokeSubscription extends AccountUpdate {
 export interface RevokeToken extends TokenUpdate {
 }
 
-export interface Ride {
+export interface RevokeUserRefreshTokens {
+    userId?: string;
+}
+
+export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
     /**
-     * Derived from driver != null
+     * 'accepted' is true if a driver has accepted the ride.
      */
     accepted?: boolean;
+    acceptedTime?: string;
     actualEndTime?: string;
     actualStartTime?: string;
     /**
-     * Derived from driveStatus != null
+     * 'arrived' is true if the driver has reported driveStatus is 'arrived_at_origin'.
      */
     arrived?: boolean;
     /**
-     * Derived from bookedTime != null
+     * 'booked' is false if the ride has only been saved.
      */
     booked?: boolean;
-    bookedTime?: string;
     booker?: AccountOrTeamRef;
     bookerReview?: Review;
-    bookingStatus?: BookingStatus;
     cancelReason?: string;
     cancelled?: boolean;
     /**
-     * Derived from driveStatus == completed
+     * 'completed' is true if the driver has reported driveStatus is 'completed'.
      */
     completed?: boolean;
     /**
-     * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
+     * 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.
      */
     desiredEndTime?: string;
     /**
-     * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
+     * 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.
      */
     desiredStartTime?: string;
     driveStatus?: DriveStatus;
-    driver?: AccountOrTeamRef;
     driverReview?: Review;
     driverSyncStatus?: SyncStatus;
     endTimeDelay?: number;
     /**
-     * Expected Time of Arrival at the Destination/Drop-off location. 
+     * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'to' or 'drop-off' location. 
      */
     expectedEndTime?: string;
     /**
-     * Expected Time of Arrival at the Origin/Pick-up location. 
+     * The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'from' or 'pick-up' location. 
      */
     expectedStartTime?: string;
     info?: RideInfo;
+    marketplaceTime?: string;
     /**
-     * Derived from plannedStartTime != null
+     * 'planned' is true if the driver has reported a planned time for the ride.
      */
     planned?: boolean;
     /**
-     * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver. 
+     * The driver determines the plannedEndTime. It means the planned time of arrival at the 'to' or 'drop-off' location. 
      */
     plannedEndTime?: string;
     plannedStartTime?: string;
     rideId?: string;
-    /**
-     * The time until which rides can be found. It's the planned time or else the desired time. 
-     */
-    searchEndTime?: string;
-    /**
-     * The time from which rides can be found. It's the planned time or else the desired time. 
-     */
-    searchStartTime?: string;
     seriesInfo?: SeriesInfo;
     startTimeDelay?: number;
     /**
-     * Derived from driveStatus != null
+     * 'started' is true if the driver has reported a driveStatus.
      */
     started?: boolean;
 }
@@ -999,9 +1143,6 @@ export interface Ride {
 export interface RideBookerCommand extends RideCommand {
 }
 
-export interface RideBookerSeriesCommand extends RideSeriesCommand {
-}
-
 export interface RideCommand {
     rideId?: string;
 }
@@ -1012,16 +1153,19 @@ export interface RideDriverCommand extends RideCommand {
 export interface RideDriverModifyCommand extends RideDriverCommand {
 }
 
-export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
-}
-
-/**
- * All durations in seconds
- */
 export interface RideDuration {
     driving?: number;
+    /**
+     * Seconds of slack for dropping off the patient, currently hardcoded to 15 minutes
+     */
     droppingOff?: number;
+    /**
+     * Seconds of slack for picking up the patient, currently hardcoded to 15 minutes
+     */
     pickingUp?: number;
+    /**
+     * Seconds of driving time plus the pick-up and drop-off slack times
+     */
     total?: number;
 }
 
@@ -1030,6 +1174,7 @@ export interface RideFilter {
     driveStatuses?: DriveStatus[];
     driverAccountNames?: string[];
     driverTeamNames?: string[];
+    entityType?: EntityType;
     hasInfection?: boolean;
     heavyWeight?: boolean;
     mobilities?: Mobility[];
@@ -1041,6 +1186,7 @@ export interface RideFilter {
     riderAccountNames?: string[];
     riderTeamNames?: string[];
     timeRange?: InstantRange;
+    unfoldRideSeries?: boolean;
     vehicleType?: VehicleType;
 }
 
@@ -1066,41 +1212,9 @@ export interface RideIdResult {
     rideId?: string;
 }
 
-/**
- * Information about the ride, from the creator of the ride
- */
-export interface RideInfo {
-    ambulanceInfo?: AmbulanceInfo;
+export interface RideInfo extends GenericRideInfo {
     appointment?: Appointment;
-    attendantsPresent?: number;
-    comment?: string;
-    dimensions?: PersonDimensions;
-    distanceInMeters?: number;
-    from?: AddressInfo;
-    /**
-     * Derived from weightInKg != null
-     */
-    heavyWeight?: boolean;
-    mobility?: Mobility;
-    patient?: Person;
-    plannedDuration?: RideDuration;
-    preferredDriver?: string;
     purpose?: RidePurpose;
-    to?: AddressInfo;
-    vehicleType?: VehicleType;
-    weightInKg?: number;
-}
-
-export interface RideInfoFilter {
-    hasInfection?: boolean;
-    heavyWeight?: boolean;
-    mobilities?: Mobility[];
-    purposes?: RidePurpose[];
-    region?: Region;
-    requiresMonitoring?: boolean;
-    requiresOxygen?: boolean;
-    requiresSuctionAspirator?: boolean;
-    vehicleType?: VehicleType;
 }
 
 export interface RideLog {
@@ -1119,39 +1233,62 @@ export interface RideLog {
     token?: boolean;
 }
 
-export interface RideOfferInfo {
-    appointment?: Appointment;
+export interface RideOperatorCommand extends RideCommand {
 }
 
-export interface RideSeries {
-    accepted?: boolean;
-    booked?: boolean;
-    booker?: AccountOrTeamRef;
-    cancelled?: boolean;
-    confirmed?: boolean;
-    driver?: AccountOrTeamRef;
-    endTime?: string;
+export interface RideOrMinimizedSeries {
+    bookingStatus?: BookingStatus;
+    entityType?: EntityType;
     info?: GenericRideInfo;
-    rideSeriesId?: string;
-    rides?: SingleRide[];
-    startTime?: string;
-    status?: RideSeriesStatus;
+    searchEndTime?: string;
+    searchStartTime?: string;
 }
 
-export interface RideSeriesCommand {
-    rideSeriesId?: string;
+export interface RideOrSeries {
+    bookedTime?: string;
+    bookingStatus?: BookingStatus;
+    cleaningAndSlack?: CleaningAndSlack;
+    driver?: AccountOrTeamRef;
+    entityType?: EntityType;
+    info?: GenericRideInfo;
+    totalDuration?: number;
 }
 
-export interface RideSeriesIdResult {
+/**
+ * A series of rides. 
+ */
+export interface RideSeries extends RideOrSeries {
+    /**
+     * 'accepted' is true if a driver has accepted the series.
+     */
+    accepted?: boolean;
+    /**
+     * The number of rides in the series that are not cancelled.
+     */
+    activeRideCount?: number;
+    /**
+     * 'booked' is false if the series has only been saved.
+     */
+    booked?: boolean;
+    booker?: AccountOrTeamRef;
+    cancelReason?: string;
+    cancelled?: boolean;
+    info?: SeriesRideInfo;
     rideSeriesId?: string;
+    rides?: Ride[];
+    ridesSummaries?: RideSummary[];
+    /**
+     * searchEndTime is the time from which series can be found in our system. It's the searchEndTime of the last ride in the series. 
+     */
+    searchEndTime?: string;
+    /**
+     * searchStartTime is the time from which series can be found in our system. It's the searchStartTime of the first ride in the series. 
+     */
+    searchStartTime?: string;
 }
 
-export interface RideSeriesPostConfirmCommand {
+export interface RideSeriesIdResult {
     rideSeriesId?: string;
-    ridesToModify?: Ride[];
-}
-
-export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
 }
 
 export interface RideSeriesUpdate {
@@ -1164,12 +1301,23 @@ export interface RideSeriesUpdate {
     type: "rideseries";
 }
 
+export interface RideSeriesUtils {
+}
+
 export interface RideStatisticsQuery {
     dateRange?: DateRange;
-    timezoneOrDefault?: string;
     zoneId?: string;
 }
 
+/**
+ * Individual ride timing within a series. Once a ride series is accepted, you cannot add rides, only remove
+ */
+export interface RideSummary {
+    appointmentTime?: string;
+    returnTrip?: boolean;
+    rideId?: string;
+}
+
 export interface RideSystemCommand extends RideCommand {
 }
 
@@ -1186,17 +1334,24 @@ export interface RideUpdate {
     type: "ride";
 }
 
-export interface Role<T> {
+export interface 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 {
-    booker?: AccountOrTeamRef;
     info?: RideInfo;
 }
 
+export interface SaveRideSeries extends CreateSeriesCommand {
+    rideSummaries?: RideSummary[];
+}
+
+export interface SecondaryTokenPermissionCommand extends TokenUpdate {
+    accountId?: string;
+}
+
 export interface SendConfirmationEmail {
     userId?: string;
 }
@@ -1208,6 +1363,7 @@ export interface SendEmail {
 export interface SendFreshdeskNewTicket {
     email?: string;
     message?: string;
+    subject?: string;
 }
 
 export interface SendInvitationEmail {
@@ -1215,17 +1371,62 @@ export interface SendInvitationEmail {
     userId?: string;
 }
 
+export interface SendKChat {
+    channel?: KChatChannel;
+    message?: string;
+}
+
 export interface SendSlack {
     channel?: SlackChannel;
     message?: string;
 }
 
+export interface SendToFirebase {
+    message?: FirebaseMessage;
+}
+
+export interface SeriesBookerCommand extends SeriesCommand {
+}
+
+export interface SeriesCommand {
+    rideSeriesId?: string;
+}
+
+export interface SeriesCommandWithSeparateEvent {
+    rideSeriesId?: string;
+}
+
+export interface SeriesDriverCommand extends SeriesCommand {
+}
+
 /**
- * Information about a ride that is part of series.
+ * If the ride is part of a series, seriesInfo will contain context about the position of the ride within the series.
  */
 export interface SeriesInfo {
+    desyncedFromSeries?: boolean;
+    positionInSeries?: number;
     returnTrip?: boolean;
     rideSeriesId?: string;
+    totalRidesInSeries?: number;
+}
+
+export interface SeriesOperatorCommand extends SeriesCommand {
+}
+
+export interface SeriesRideInfo extends GenericRideInfo {
+    purpose?: SeriesPurpose;
+}
+
+export interface SetOperations extends AccountUpdate {
+    operateAccounts?: string[];
+}
+
+export interface SetOperator extends AccountUpdate {
+    operator?: string;
+}
+
+export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
+    accountPermission?: AccountPermission;
 }
 
 export interface SetSettings extends AccountUpdate {
@@ -1255,16 +1456,6 @@ export interface SignUpUser {
     userId?: string;
 }
 
-export interface SingleRide {
-    desiredStartTime?: string;
-    returnTrip?: boolean;
-}
-
-export interface SingleRideUpdate {
-    desiredStartTime?: string;
-    rideId?: string;
-}
-
 export interface StopImpersonatingUser {
 }
 
@@ -1314,10 +1505,11 @@ export interface TimedPermission {
 }
 
 export interface Token {
-    accountPermission?: AccountPermission;
+    accountPermissions?: AccountPermission[];
     createdBy?: string;
     info?: TokenInfo;
     lastUpdatedBy?: string;
+    owner?: string;
     revoked?: boolean;
     tokenId?: string;
 }
@@ -1360,9 +1552,19 @@ export interface UpdateRidePlan extends RideDriverModifyCommand {
     plannedStartTime?: string;
 }
 
-export interface UpdateRideSeries extends RideBookerSeriesCommand {
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
+export interface UpdateRideSeries extends SeriesCommandWithSeparateEvent {
+    booker?: AccountOrTeamRef;
+    info?: SeriesRideInfo;
+    rideSummaries?: RideSummary[];
+}
+
+export interface UpdateRideSeriesEvent extends SeriesBookerCommand {
+    addRides?: string[];
+    booker?: AccountOrTeamRef;
+    cancelRides?: string[];
+    info?: SeriesRideInfo;
+    rideSummaries?: RideSummary[];
+    updateRides?: string[];
 }
 
 export interface UpdateTeam extends TeamUpdate {
@@ -1416,12 +1618,32 @@ export interface UserUpdate extends UserCommand {
 export interface UserUpdateAfterSignup extends UserUpdate {
 }
 
+export interface WebsocketFilter {
+    screen: "ride_details" | "fleet_overview" | "hospital_overview" | "marketplace" | "operations_overview";
+}
+
+export interface WebsocketMultipleUpdates extends WebsocketUpdate {
+    ridesAndSeries?: RideOrMinimizedSeries[];
+    ridesCount?: RideFilterCount;
+    type: "multiple_updates";
+}
+
+export interface WebsocketSingleUpdate extends WebsocketUpdate {
+    id?: string;
+    rideOrSeries?: RideOrMinimizedSeries;
+    type: "single_update";
+}
+
+export interface WebsocketUpdate {
+    type: "multiple_updates" | "single_update";
+}
+
 export interface ZonedTimeRange {
     end?: Date;
     start?: Date;
 }
 
-export type AccountRole = "ridebooker" | "dispatcher" | "admin" | "owner";
+export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
 
 export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
 
@@ -1431,32 +1653,42 @@ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
 
 export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
 
+export type EntityType = "ride" | "rideseries";
+
 export type GeometryUnion = GeoPolygon | GeoMultiPolygon;
 
 export type InsuranceType = "public_insurance" | "private_insurance" | "german_accident_insurance" | "no_or_unknown_insurance";
 
 export type IntegrationType = "dispolive" | "celios";
 
+export type KChatChannel = "ride_notifications" | "urgent_issues" | "account_tasks" | "customer_issues";
+
 export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
 
-export type OrganisationType = "medical" | "fleet";
+export type OrganisationType = "medical" | "fleet" | "operator";
 
 export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
 
-export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
+export type Screen = "marketplace" | "operations_overview" | "hospital_overview" | "fleet_overview" | "ride_details";
+
+export type SeriesPurpose = "consultation";
 
-export type Service = "pro_medical" | "pro_fleet" | "celios_integration" | "dispolive_integration";
+export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";
 
 export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
 
-export type StandaloneService = "pro_medical" | "pro_fleet";
+export type StandaloneService = "pro_medical" | "pro_fleet" | "pro_operator";
 
 export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
 
 export type TeamRole = "dispatcher" | "ridebooker";
 
-export type TrackingUpdateType = "ride" | "rideseries";
-
 export type UserRole = "superadmin";
 
 export type VehicleType = "taxi" | "ambulance";
+
+export type WebsocketFilterUnion = MarketplaceOverviewFilter | HospitalOverviewFilter | FleetOverviewFilter | OperationsOverviewFilter | DetailsFilter;
+
+export type WebsocketUpdateType = "single_update" | "multiple_updates";
+
+export type WebsocketUpdateUnion = WebsocketSingleUpdate | WebsocketMultipleUpdates;

package/package.json

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