@moxi.gmbh/moxi-typescriptmodels 0.1.1701-test-server → 0.1.1721-test-server

package/common.d.ts

@@ -203,6 +203,10 @@ export interface AssignDriver extends RideOperatorCommand {
     driver?: AccountOrTeamRef;
 }
 
+export interface AssignRideSeriesDriver extends SeriesOperatorCommand {
+    driver?: AccountOrTeamRef;
+}
+
 export interface Attachment {
     base64Data?: string;
     fileName?: string;
@@ -229,15 +233,19 @@ export interface BookRide extends CreateRideCommand {
 }
 
 export interface BookRideSeries extends CreateSeriesCommand {
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
+    rideSummaries?: RideSummary[];
 }
 
 export interface CancelRide extends RideBookerCommand {
     reason?: string;
 }
 
-export interface CancelRideSeries extends SeriesBookerModifyCommand {
+export interface CancelRideSeries extends SeriesCommandWithSeparateEvent {
+    reason?: string;
+}
+
+export interface CancelRideSeriesEvent extends SeriesBookerCommand {
+    cancelRides?: string[];
     reason?: string;
 }
 
@@ -301,16 +309,9 @@ export interface CreateRideCommand extends RideBookerCommand {
     booker?: AccountOrTeamRef;
 }
 
-export interface CreateRideFromSeries extends RideCommand {
-    bookedTime?: string;
-    booker?: AccountOrTeamRef;
-    driver?: AccountOrTeamRef;
-    info?: RideInfo;
-    seriesInfo?: SeriesInfo;
-}
-
 export interface CreateSeriesCommand extends SeriesBookerCommand {
     booker?: AccountOrTeamRef;
+    info?: GenericRideInfo;
 }
 
 export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -489,7 +490,7 @@ export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMark
 }
 
 export interface FindRidesAndSeriesResult {
-    ridesAndSeries?: RideOrSeriesUnion[];
+    ridesAndSeries?: RideOrSeries[];
     ridesCount?: RideFilterCount;
 }
 
@@ -709,6 +710,10 @@ export interface GetRidesInMarketplace {
     timeRange?: InstantRange;
 }
 
+export interface GetRidesInSeries {
+    rideSeriesId?: string;
+}
+
 export interface GetSeriesForDriver {
     accountId?: string;
     maxSize?: number;
@@ -720,8 +725,7 @@ export interface GetSeriesInMarketplace {
     maxSize?: number;
 }
 
-export interface GetSplitRideSeries {
-    filter?: RideFilter;
+export interface GetSeriesLog {
     rideSeriesId?: string;
 }
 
@@ -809,6 +813,12 @@ 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 {
+}
+
 export interface NutsDistrict {
     code?: string;
     name?: string;
@@ -1026,7 +1036,6 @@ export interface Ride extends RideOrSeries {
     driverReview?: Review;
     driverSyncStatus?: SyncStatus;
     endTimeDelay?: number;
-    entityType: "ride";
     /**
      * Expected Time of Arrival at the Destination/Drop-off location. 
      */
@@ -1151,16 +1160,12 @@ export interface RideLog {
     token?: boolean;
 }
 
-export interface RideOfferInfo {
-    appointment?: Appointment;
-}
-
 export interface RideOperatorCommand extends RideCommand {
 }
 
 export interface RideOrSeries {
     bookingStatus?: BookingStatus;
-    entityType: "ride" | "rideseries";
+    entityType?: EntityType;
     info?: GenericRideInfo;
 }
 
@@ -1181,12 +1186,12 @@ export interface RideSeries extends RideOrSeries {
     cancelReason?: string;
     cancelled?: boolean;
     driver?: AccountOrTeamRef;
-    entityType: "rideseries";
+    rideCount?: number;
     rideSeriesId?: string;
-    rides?: SingleRide[];
+    rides?: Ride[];
+    ridesSummaries?: RideSummary[];
     searchEndTime?: string;
     searchStartTime?: string;
-    split?: boolean;
 }
 
 export interface RideSeriesIdResult {
@@ -1203,11 +1208,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 {
 }
 
@@ -1235,8 +1252,7 @@ export interface SaveRide extends CreateRideCommand {
 }
 
 export interface SaveRideSeries extends CreateSeriesCommand {
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
+    rideSummaries?: RideSummary[];
 }
 
 export interface SecondaryTokenPermissionCommand extends TokenUpdate {
@@ -1270,10 +1286,11 @@ export interface SendSlack {
 export interface SeriesBookerCommand extends SeriesCommand {
 }
 
-export interface SeriesBookerModifyCommand extends SeriesBookerCommand {
+export interface SeriesCommand {
+    rideSeriesId?: string;
 }
 
-export interface SeriesCommand {
+export interface SeriesCommandWithSeparateEvent {
     rideSeriesId?: string;
 }
 
@@ -1284,13 +1301,14 @@ 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 SeriesUpcaster {
+export interface SeriesOperatorCommand extends SeriesCommand {
 }
 
 export interface SetOperations extends AccountUpdate {
@@ -1332,18 +1350,6 @@ export interface SignUpUser {
     userId?: string;
 }
 
-/**
- * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
- */
-export interface SingleRide {
-    appointmentTime?: string;
-    returnTrip?: boolean;
-    rideId?: string;
-}
-
-export interface SplitRideSeries extends SeriesDriverCommand {
-}
-
 export interface StopImpersonatingUser {
 }
 
@@ -1440,10 +1446,19 @@ export interface UpdateRidePlan extends RideDriverModifyCommand {
     plannedStartTime?: string;
 }
 
-export interface UpdateRideSeries extends SeriesBookerModifyCommand {
+export interface UpdateRideSeries extends SeriesCommandWithSeparateEvent {
     booker?: AccountOrTeamRef;
     info?: GenericRideInfo;
-    rides?: SingleRide[];
+    rideSummaries?: RideSummary[];
+}
+
+export interface UpdateRideSeriesEvent extends SeriesBookerCommand {
+    addRides?: string[];
+    booker?: AccountOrTeamRef;
+    cancelRides?: string[];
+    info?: GenericRideInfo;
+    rideSummaries?: RideSummary[];
+    updateRides?: string[];
 }
 
 export interface UpdateTeam extends TeamUpdate {
@@ -1506,7 +1521,7 @@ export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "
 
 export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
 
-export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "confirmed" | "cancelled";
+export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
 
 export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
 
@@ -1524,8 +1539,6 @@ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chai
 
 export type OrganisationType = "medical" | "fleet" | "operator";
 
-export type RideOrSeriesUnion = Ride | RideSeries;
-
 export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
 
 export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";

package/package.json

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