@moxi.gmbh/moxi-typescriptmodels 0.1.791 → 0.1.801

package/common.d.ts

@@ -1,9 +1,40 @@
 
+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;
+    maxSize?: number;
+    term?: string;
+}
+
 export interface AcceptRide extends RideDriverCommand {
     driver?: AccountOrTeamRef;
 }
 
-export interface AcceptRideSeries extends RideDriverSeriesCommand {
+export interface AcceptRideSeries extends SeriesDriverCommand {
     driver?: AccountOrTeamRef;
 }
 
@@ -151,16 +182,15 @@ export interface AmbulanceInfo {
 }
 
 /**
- * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
-
+ * Information about the ride, from the creator of the ride
  */
-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 {
@@ -172,6 +202,10 @@ export interface AssignDriver extends RideOperatorCommand {
     driver?: AccountOrTeamRef;
 }
 
+export interface AssignRideSeriesDriver extends SeriesOperatorCommand {
+    driver?: AccountOrTeamRef;
+}
+
 export interface Attachment {
     base64Data?: string;
     fileName?: string;
@@ -193,36 +227,25 @@ export interface AuthenticationResponse {
 export interface AuthenticationService {
 }
 
-export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
-    info?: GenericRideInfo;
-    updater?: AccountOrTeamRef;
-}
-
-export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
-    rides?: SingleRideUpdate[];
-    updater?: AccountOrTeamRef;
-}
-
 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 {
@@ -282,17 +305,12 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
 }
 
 export interface CreateRideCommand extends RideBookerCommand {
-    booker?: AccountOrTeamId;
-}
-
-export interface CreateRideFromSeries extends RideDriverCommand {
     booker?: AccountOrTeamRef;
-    driver?: AccountOrTeamRef;
-    info?: RideInfo;
-    seriesInfo?: SeriesInfo;
 }
 
-export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
+export interface CreateSeriesCommand extends SeriesBookerCommand {
+    booker?: AccountOrTeamRef;
+    info?: SeriesRideInfo;
 }
 
 export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -438,42 +456,13 @@ export interface FindAccounts {
     term?: string;
 }
 
-/**
- * @deprecated
- */
-export interface FindMyAcceptedRides {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMyRides extends AbstractFindMyRides {
 }
 
-/**
- * @deprecated
- */
-export interface FindMyRideOffers {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMyRidesAndSeries extends AbstractFindMyRides {
 }
 
-export interface FindMyRideSeries {
-    accountId?: string;
-    descending?: boolean;
-    maxSize?: number;
-    term?: string;
-    timeRange?: InstantRange;
-}
-
-export interface FindMyRides {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindMySeries extends AbstractFindMyRides {
 }
 
 export interface FindMyTokens {
@@ -487,45 +476,27 @@ export interface FindMyUsers {
     term?: string;
 }
 
-export interface FindPotentialRideSeries {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideInfoFilter;
-    maxSize?: number;
+export interface FindRides extends AbstractFindRides {
 }
 
-/**
- * @deprecated
- */
-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 FindRidesForDriver {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMarketplace {
 }
 
-export interface FindRidesInMarketplace {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
+export interface FindRidesAndSeriesResult {
+    ridesAndSeries?: RideOrMinimizedSeries[];
+    ridesCount?: RideFilterCount;
+}
+
+export interface FindRidesForDriver extends AbstractFindRidesForDriver {
+}
+
+export interface FindRidesInMarketplace extends AbstractFindRidesInMarketplace {
 }
 
 export interface FindRidesResult {
@@ -533,6 +504,15 @@ 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;
 }
@@ -571,7 +551,6 @@ export interface GenericRideInfo {
     patient?: Person;
     plannedDuration?: RideDuration;
     preferredDriver?: string;
-    purpose?: RidePurpose;
     to?: AddressInfo;
     vehicleType?: VehicleType;
     weightInKg?: number;
@@ -619,18 +598,6 @@ export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
 export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
 }
 
-export interface GetAllRideSeriesForDriver {
-    accountId?: string;
-    descending?: boolean;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
-export interface GetAllRideSeriesInMarketplace {
-    accountId?: string;
-    maxSize?: number;
-}
-
 export interface GetDistrict {
     geoLocation?: GeoLocation;
     stateNutsCode?: string;
@@ -651,29 +618,17 @@ export interface GetIsoStates {
 export interface GetMonopolyAccounts {
 }
 
-/**
- * @deprecated
- */
-export interface GetMyAcceptedRides {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
 export interface GetMyAccounts {
     filter?: AccountFilter;
 }
 
-/**
- * @deprecated
- */
-export interface GetMyRideOffers {
+export interface GetMyRides {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetMyRides {
+export interface GetMySeries {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
@@ -688,6 +643,10 @@ export interface GetMyUserProfile {
 export interface GetNutsStates {
 }
 
+export interface GetOneSeries {
+    rideSeriesId?: string;
+}
+
 /**
  * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
 
@@ -714,15 +673,6 @@ export interface GetPotentialDriversAbstract {
     weightInKg?: number;
 }
 
-/**
- * @deprecated
- */
-export interface GetPotentialRides {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
-}
-
 export interface GetRide {
     rideId?: string;
 }
@@ -742,30 +692,38 @@ export interface GetRideLog {
     rideId?: string;
 }
 
-export interface GetRideSeries {
-    rideSeriesId?: string;
+export interface GetRideOrSeries {
+    id?: string;
 }
 
-export interface GetRideSeriesForDriver {
+export interface GetRidesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetRidesForDriver {
+export interface GetRidesInMarketplace {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetRidesInMarketplace {
+export interface GetRidesInSeries {
+    rideSeriesId?: string;
+}
+
+export interface GetSeriesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetRidesInSeries {
-    filter?: RideFilter;
+export interface GetSeriesInMarketplace {
+    accountId?: string;
+    maxSize?: number;
+}
+
+export interface GetSeriesLog {
     rideSeriesId?: string;
 }
 
@@ -853,6 +811,13 @@ export interface Metric {
     updates?: string[];
 }
 
+/**
+ * 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. 
+ */
+export interface MinimizedRideSeries extends RideSeries, RideOrMinimizedSeries {
+    info?: SeriesRideInfo;
+}
+
 export interface NutsDistrict {
     code?: string;
     name?: string;
@@ -911,7 +876,7 @@ export interface ReadUpdates {
     maxSize?: number;
     maxTimeout?: number;
     tokenId?: string;
-    updateTypes?: TrackingUpdateType[];
+    updateTypes?: EntityType[];
 }
 
 export interface ReadUpdatesResult {
@@ -1000,7 +965,7 @@ export interface ResetPosition {
 export interface ReturnRide extends RideDriverModifyCommand {
 }
 
-export interface ReturnRideSeries extends RideDriverSeriesCommand {
+export interface ReturnRideSeries extends SeriesDriverCommand {
 }
 
 export interface Review {
@@ -1033,7 +998,7 @@ export interface RevokeSubscription extends AccountUpdate {
 export interface RevokeToken extends TokenUpdate {
 }
 
-export interface Ride {
+export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
     /**
      * Derived from driver != null
      */
@@ -1051,7 +1016,6 @@ export interface Ride {
     bookedTime?: string;
     booker?: AccountOrTeamRef;
     bookerReview?: Review;
-    bookingStatus?: BookingStatus;
     cancelReason?: string;
     cancelled?: boolean;
     /**
@@ -1109,9 +1073,6 @@ export interface Ride {
 export interface RideBookerCommand extends RideCommand {
 }
 
-export interface RideBookerSeriesCommand extends RideSeriesCommand {
-}
-
 export interface RideCommand {
     rideId?: string;
 }
@@ -1122,9 +1083,6 @@ export interface RideDriverCommand extends RideCommand {
 export interface RideDriverModifyCommand extends RideDriverCommand {
 }
 
-export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
-}
-
 /**
  * All durations in seconds
  */
@@ -1140,6 +1098,7 @@ export interface RideFilter {
     driveStatuses?: DriveStatus[];
     driverAccountNames?: string[];
     driverTeamNames?: string[];
+    entityType?: EntityType;
     hasInfection?: boolean;
     heavyWeight?: boolean;
     mobilities?: Mobility[];
@@ -1151,6 +1110,7 @@ export interface RideFilter {
     riderAccountNames?: string[];
     riderTeamNames?: string[];
     timeRange?: InstantRange;
+    unfoldRideSeries?: boolean;
     vehicleType?: VehicleType;
 }
 
@@ -1179,38 +1139,9 @@ export interface RideIdResult {
 /**
  * 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 {
@@ -1229,44 +1160,51 @@ export interface RideLog {
     token?: boolean;
 }
 
-export interface RideOfferInfo {
-    appointment?: Appointment;
+export interface RideOperatorCommand extends RideCommand {
 }
 
-export interface RideOperatorCommand extends RideCommand {
+export interface RideOrMinimizedSeries {
+    bookingStatus?: BookingStatus;
+    entityType?: EntityType;
+    info?: GenericRideInfo;
 }
 
-export interface RideSeries {
+export interface RideOrSeries {
+    bookingStatus?: BookingStatus;
+    entityType?: EntityType;
+    info?: GenericRideInfo;
+}
+
+/**
+ * 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. 
+ */
+export interface RideSeries extends RideOrSeries {
+    /**
+     * Derived from driver != null
+     */
     accepted?: boolean;
+    activeRideCount?: number;
+    /**
+     * Derived from bookedTime != null
+     */
     booked?: boolean;
+    bookedTime?: string;
     booker?: AccountOrTeamRef;
+    cancelReason?: string;
     cancelled?: boolean;
-    confirmed?: boolean;
     driver?: AccountOrTeamRef;
-    endTime?: string;
-    info?: GenericRideInfo;
-    rideSeriesId?: string;
-    rides?: SingleRide[];
-    startTime?: string;
-    status?: RideSeriesStatus;
-}
-
-export interface RideSeriesCommand {
+    info?: SeriesRideInfo;
     rideSeriesId?: string;
+    rides?: Ride[];
+    ridesSummaries?: RideSummary[];
+    searchEndTime?: string;
+    searchStartTime?: string;
 }
 
 export interface RideSeriesIdResult {
     rideSeriesId?: string;
 }
 
-export interface RideSeriesPostConfirmCommand {
-    rideSeriesId?: string;
-    ridesToModify?: Ride[];
-}
-
-export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
-}
-
 export interface RideSeriesUpdate {
     after?: RideSeries;
     before?: RideSeries;
@@ -1277,11 +1215,23 @@ export interface RideSeriesUpdate {
     type: "rideseries";
 }
 
+export interface RideSeriesUtils {
+}
+
 export interface RideStatisticsQuery {
     dateRange?: DateRange;
     zoneId?: string;
 }
 
+/**
+ * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
+ */
+export interface RideSummary {
+    appointmentTime?: string;
+    returnTrip?: boolean;
+    rideId?: string;
+}
+
 export interface RideSystemCommand extends RideCommand {
 }
 
@@ -1298,17 +1248,20 @@ 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;
 }
@@ -1337,12 +1290,39 @@ export interface SendSlack {
     message?: string;
 }
 
+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.
  */
 export interface SeriesInfo {
+    desyncedFromSeries?: boolean;
+    positionInSeries?: number;
     returnTrip?: boolean;
     rideSeriesId?: string;
+    totalRidesInSeries?: number;
+}
+
+export interface SeriesOperatorCommand extends SeriesCommand {
+}
+
+/**
+ * Information about the ride, from the creator of the ride
+ */
+export interface SeriesRideInfo extends GenericRideInfo {
+    purpose?: SeriesPurpose;
 }
 
 export interface SetOperations extends AccountUpdate {
@@ -1384,19 +1364,6 @@ export interface SignUpUser {
     userId?: string;
 }
 
-/**
- * Individual ride timing within a series
- */
-export interface SingleRide {
-    desiredStartTime?: string;
-    returnTrip?: boolean;
-}
-
-export interface SingleRideUpdate {
-    desiredStartTime?: string;
-    rideId?: string;
-}
-
 export interface StopImpersonatingUser {
 }
 
@@ -1493,9 +1460,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 {
@@ -1564,6 +1541,8 @@ 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";
@@ -1576,7 +1555,7 @@ export type OrganisationType = "medical" | "fleet" | "operator";
 
 export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
 
-export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
+export type SeriesPurpose = "consultation";
 
 export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";
 
@@ -1588,8 +1567,6 @@ 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";

package/package.json

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