@moxi.gmbh/moxi-typescriptmodels 0.1.1351-test-server → 0.1.1361-test-server

package/common.d.ts

@@ -3,7 +3,7 @@ export interface AcceptRide extends RideDriverCommand {
     driver?: AccountOrTeamRef;
 }
 
-export interface AcceptRideSeries extends SeriesDriverCommand {
+export interface AcceptRideSeries extends RideDriverSeriesCommand {
     driver?: AccountOrTeamRef;
 }
 
@@ -26,6 +26,7 @@ export interface Account {
     drivePermissions?: DrivePermission[];
     info?: AccountInfo;
     integrationSettings?: any[];
+    operateAccounts?: string[];
     subscriptions?: Subscription[];
     teams?: Team[];
     unconfirmedCriticalInfo?: CriticalAccountInfo;
@@ -183,12 +184,22 @@ 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 SeriesBookerCommand {
+export interface BookRideSeries extends RideBookerSeriesCommand {
     booker?: AccountOrTeamRef;
     info?: GenericRideInfo;
     rides?: SingleRide[];
@@ -198,8 +209,11 @@ export interface CancelRide extends RideBookerCommand {
     reason?: string;
 }
 
-export interface CancelRideSeries extends SeriesBookerModifyCommand {
-    reason?: string;
+export interface CancelRideSeries extends RideBookerSeriesCommand {
+}
+
+export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
+    updater?: AccountOrTeamRef;
 }
 
 export interface CeliosSettings {
@@ -262,14 +276,16 @@ export interface CreateRideCommand extends RideBookerCommand {
     booker?: AccountOrTeamId;
 }
 
-export interface CreateRideFromSeries extends RideCommand {
-    bookedTime?: string;
+export interface CreateRideFromSeries extends RideDriverCommand {
     booker?: AccountOrTeamRef;
     driver?: AccountOrTeamRef;
     info?: RideInfo;
     seriesInfo?: SeriesInfo;
 }
 
+export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
+}
+
 export interface CreateSqueezeInPlan extends OptimizerMessage {
     accountOrTeam?: AccountOrTeamRef;
 }
@@ -413,7 +429,10 @@ export interface FindAccounts {
     term?: string;
 }
 
-export interface FindMyRides {
+/**
+ * @deprecated
+ */
+export interface FindMyAcceptedRides {
     accountId?: string;
     descending?: boolean;
     filter?: RideFilter;
@@ -421,7 +440,10 @@ export interface FindMyRides {
     term?: string;
 }
 
-export interface FindMyRidesAndSeries {
+/**
+ * @deprecated
+ */
+export interface FindMyRideOffers {
     accountId?: string;
     descending?: boolean;
     filter?: RideFilter;
@@ -429,7 +451,15 @@ export interface FindMyRidesAndSeries {
     term?: string;
 }
 
-export interface FindMySeries {
+export interface FindMyRideSeries {
+    accountId?: string;
+    descending?: boolean;
+    maxSize?: number;
+    term?: string;
+    timeRange?: InstantRange;
+}
+
+export interface FindMyRides {
     accountId?: string;
     descending?: boolean;
     filter?: RideFilter;
@@ -449,21 +479,17 @@ export interface FindMyUsers {
     term?: string;
 }
 
-export interface FindRides {
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
-}
-
-export interface FindRidesAndSeries {
+export interface FindPotentialRideSeries {
+    accountId?: string;
     descending?: boolean;
-    filter?: RideFilter;
+    filter?: RideInfoFilter;
     maxSize?: number;
-    term?: string;
 }
 
-export interface FindRidesAndSeriesForDriver {
+/**
+ * @deprecated
+ */
+export interface FindPotentialRides {
     accountId?: string;
     descending?: boolean;
     filter?: RideFilter;
@@ -471,19 +497,13 @@ export interface FindRidesAndSeriesForDriver {
     term?: string;
 }
 
-export interface FindRidesAndSeriesInMarketplace {
-    accountId?: string;
+export interface FindRides {
     descending?: boolean;
     filter?: RideFilter;
     maxSize?: number;
     term?: string;
 }
 
-export interface FindRidesAndSeriesResult {
-    ridesAndSeries?: RideOrSeriesUnion[];
-    ridesCount?: RideFilterCount;
-}
-
 export interface FindRidesForDriver {
     accountId?: string;
     descending?: boolean;
@@ -505,29 +525,6 @@ export interface FindRidesResult {
     rides?: Ride[];
 }
 
-export interface FindSeries {
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
-}
-
-export interface FindSeriesForDriver {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
-}
-
-export interface FindSeriesInMarketplace {
-    accountId?: string;
-    descending?: boolean;
-    filter?: RideFilter;
-    maxSize?: number;
-    term?: string;
-}
-
 export interface FindTokens {
     term?: string;
 }
@@ -603,6 +600,18 @@ export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
 export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
 }
 
+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;
@@ -623,17 +632,29 @@ export interface GetIsoStates {
 export interface GetMonopolyAccounts {
 }
 
+/**
+ * @deprecated
+ */
+export interface GetMyAcceptedRides {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
+}
+
 export interface GetMyAccounts {
     filter?: AccountFilter;
 }
 
-export interface GetMyRides {
+/**
+ * @deprecated
+ */
+export interface GetMyRideOffers {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetMySeries {
+export interface GetMyRides {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
@@ -648,10 +669,6 @@ export interface GetMyUserProfile {
 export interface GetNutsStates {
 }
 
-export interface GetOneSeries {
-    rideSeriesId?: string;
-}
-
 export interface GetPotentialDrivers {
     fromDistrict?: string;
     mobility?: Mobility;
@@ -660,6 +677,15 @@ export interface GetPotentialDrivers {
     weightInKg?: number;
 }
 
+/**
+ * @deprecated
+ */
+export interface GetPotentialRides {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
+}
+
 export interface GetRide {
     rideId?: string;
 }
@@ -679,30 +705,29 @@ export interface GetRideLog {
     rideId?: string;
 }
 
-export interface GetRidesForDriver {
-    accountId?: string;
-    maxSize?: number;
-    timeRange?: InstantRange;
+export interface GetRideSeries {
+    rideSeriesId?: string;
 }
 
-export interface GetRidesInMarketplace {
+export interface GetRideSeriesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetSeriesForDriver {
+export interface GetRidesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetSeriesInMarketplace {
+export interface GetRidesInMarketplace {
     accountId?: string;
     maxSize?: number;
+    timeRange?: InstantRange;
 }
 
-export interface GetSplitRideSeries {
+export interface GetRidesInSeries {
     filter?: RideFilter;
     rideSeriesId?: string;
 }
@@ -841,7 +866,7 @@ export interface ReadUpdates {
     maxSize?: number;
     maxTimeout?: number;
     tokenId?: string;
-    updateTypes?: EntityType[];
+    updateTypes?: TrackingUpdateType[];
 }
 
 export interface ReadUpdatesResult {
@@ -922,7 +947,7 @@ export interface ResetPosition {
 export interface ReturnRide extends RideDriverModifyCommand {
 }
 
-export interface ReturnRideSeries extends SeriesDriverCommand {
+export interface ReturnRideSeries extends RideDriverSeriesCommand {
 }
 
 export interface Review {
@@ -952,7 +977,7 @@ export interface RevokeSubscription extends AccountUpdate {
 export interface RevokeToken extends TokenUpdate {
 }
 
-export interface Ride extends RideOrSeries {
+export interface Ride {
     /**
      * Derived from driver != null
      */
@@ -990,7 +1015,6 @@ export interface Ride extends RideOrSeries {
     driverReview?: Review;
     driverSyncStatus?: SyncStatus;
     endTimeDelay?: number;
-    entityType: "ride";
     /**
      * Expected Time of Arrival at the Destination/Drop-off location. 
      */
@@ -1029,6 +1053,9 @@ export interface Ride extends RideOrSeries {
 export interface RideBookerCommand extends RideCommand {
 }
 
+export interface RideBookerSeriesCommand extends RideSeriesCommand {
+}
+
 export interface RideCommand {
     rideId?: string;
 }
@@ -1039,6 +1066,9 @@ export interface RideDriverCommand extends RideCommand {
 export interface RideDriverModifyCommand extends RideDriverCommand {
 }
 
+export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
+}
+
 /**
  * All durations in seconds
  */
@@ -1115,6 +1145,18 @@ export interface RideInfo {
     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 {
     actingFor?: AccountOrTeamRef;
     allowedViewers?: AccountOrTeamRef[];
@@ -1135,41 +1177,37 @@ export interface RideOfferInfo {
     appointment?: Appointment;
 }
 
-export interface RideOrSeries {
-    entityType: "ride" | "rideseries";
-}
-
-/**
- * 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
-     */
+export interface RideSeries {
     accepted?: boolean;
-    /**
-     * Derived from bookedTime != null
-     */
     booked?: boolean;
-    bookedTime?: string;
     booker?: AccountOrTeamRef;
-    bookingStatus?: BookingStatus;
-    cancelReason?: string;
     cancelled?: boolean;
+    confirmed?: boolean;
     driver?: AccountOrTeamRef;
-    entityType: "rideseries";
+    endTime?: string;
     info?: GenericRideInfo;
     rideSeriesId?: string;
     rides?: SingleRide[];
-    searchEndTime?: string;
-    searchStartTime?: string;
-    split?: boolean;
+    startTime?: string;
+    status?: RideSeriesStatus;
+}
+
+export interface RideSeriesCommand {
+    rideSeriesId?: 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;
@@ -1212,12 +1250,6 @@ export interface SaveRide extends CreateRideCommand {
     info?: RideInfo;
 }
 
-export interface SaveRideSeries extends SeriesBookerCommand {
-    booker?: AccountOrTeamRef;
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
-}
-
 export interface SendConfirmationEmail {
     userId?: string;
 }
@@ -1241,19 +1273,6 @@ export interface SendSlack {
     message?: string;
 }
 
-export interface SeriesBookerCommand extends SeriesCommand {
-}
-
-export interface SeriesBookerModifyCommand extends SeriesBookerCommand {
-}
-
-export interface SeriesCommand {
-    rideSeriesId?: string;
-}
-
-export interface SeriesDriverCommand extends SeriesCommand {
-}
-
 /**
  * Information about a ride that is part of series.
  */
@@ -1262,6 +1281,14 @@ export interface SeriesInfo {
     rideSeriesId?: string;
 }
 
+export interface SetOperateAccounts extends AccountUpdate {
+    operateAccounts?: string[];
+}
+
+export interface SetOperator extends AccountUpdate {
+    operator?: string;
+}
+
 export interface SetSettings extends AccountUpdate {
     settings?: any;
 }
@@ -1290,15 +1317,16 @@ export interface SignUpUser {
 }
 
 /**
- * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
+ * Individual ride timing within a series
  */
 export interface SingleRide {
     desiredStartTime?: string;
     returnTrip?: boolean;
-    rideId?: string;
 }
 
-export interface SplitRideSeries extends SeriesDriverCommand {
+export interface SingleRideUpdate {
+    desiredStartTime?: string;
+    rideId?: string;
 }
 
 export interface StopImpersonatingUser {
@@ -1388,6 +1416,7 @@ export interface UpdatePosition {
 }
 
 export interface UpdateRide extends RideBookerCommand {
+    booker?: AccountOrTeamRef;
     info?: RideInfo;
 }
 
@@ -1395,7 +1424,7 @@ export interface UpdateRidePlan extends RideDriverModifyCommand {
     plannedStartTime?: string;
 }
 
-export interface UpdateRideSeries extends SeriesBookerModifyCommand {
+export interface UpdateRideSeries extends RideBookerSeriesCommand {
     info?: GenericRideInfo;
     rides?: SingleRide[];
 }
@@ -1466,8 +1495,6 @@ 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";
@@ -1476,22 +1503,24 @@ export type IntegrationType = "dispolive" | "celios";
 
 export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
 
-export type OrganisationType = "medical" | "fleet";
-
-export type RideOrSeriesUnion = Ride | RideSeries;
+export type OrganisationType = "medical" | "fleet" | "operator";
 
 export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
 
-export type Service = "pro_medical" | "pro_fleet" | "celios_integration" | "dispolive_integration" | "ride_series";
+export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
+
+export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration";
 
 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";

package/package.json

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