@moxi.gmbh/moxi-typescriptmodels 0.1.1501-test-server → 0.1.1532-test-server

package/common.d.ts

@@ -1,40 +1,9 @@
 
-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 SeriesDriverCommand {
+export interface AcceptRideSeries extends RideDriverSeriesCommand {
     driver?: AccountOrTeamRef;
 }
 
@@ -220,11 +189,23 @@ 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 CreateSeriesCommand {
+export interface BookRideSeries extends RideBookerSeriesCommand {
+    booker?: AccountOrTeamRef;
     info?: GenericRideInfo;
     rides?: SingleRide[];
 }
@@ -233,8 +214,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 {
@@ -294,19 +278,17 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
 }
 
 export interface CreateRideCommand extends RideBookerCommand {
-    booker?: AccountOrTeamRef;
+    booker?: AccountOrTeamId;
 }
 
-export interface CreateRideFromSeries extends RideCommand {
-    bookedTime?: string;
+export interface CreateRideFromSeries extends RideDriverCommand {
     booker?: AccountOrTeamRef;
     driver?: AccountOrTeamRef;
     info?: RideInfo;
     seriesInfo?: SeriesInfo;
 }
 
-export interface CreateSeriesCommand extends SeriesBookerCommand {
-    booker?: AccountOrTeamRef;
+export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
 }
 
 export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -452,18 +434,46 @@ export interface FindAccounts {
     term?: string;
 }
 
-export interface FindMyRides extends AbstractFindMyRides {
+/**
+ * @deprecated
+ */
+export interface FindMyAcceptedRides {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
+}
+
+/**
+ * @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 FindMySeries extends AbstractFindMyRides {
+export interface FindMyRides {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
 }
 
 export interface FindMyTokens {
     accountId?: string;
-    teamId?: string;
     term?: string;
 }
 
@@ -473,27 +483,45 @@ export interface FindMyUsers {
     term?: string;
 }
 
-export interface FindRides extends AbstractFindRides {
-}
-
-export interface FindRidesAndSeries extends AbstractFindRides {
-}
-
-export interface FindRidesAndSeriesForDriver extends AbstractFindRidesForDriver {
+export interface FindPotentialRideSeries {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideInfoFilter;
+    maxSize?: number;
 }
 
-export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMarketplace {
+/**
+ * @deprecated
+ */
+export interface FindPotentialRides {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
 }
 
-export interface FindRidesAndSeriesResult {
-    ridesAndSeries?: RideOrSeriesUnion[];
-    ridesCount?: RideFilterCount;
+export interface FindRides {
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
 }
 
-export interface FindRidesForDriver extends AbstractFindRidesForDriver {
+export interface FindRidesForDriver {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
 }
 
-export interface FindRidesInMarketplace extends AbstractFindRidesInMarketplace {
+export interface FindRidesInMarketplace {
+    accountId?: string;
+    descending?: boolean;
+    filter?: RideFilter;
+    maxSize?: number;
+    term?: string;
 }
 
 export interface FindRidesResult {
@@ -501,15 +529,6 @@ 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;
 }
@@ -524,6 +543,11 @@ export interface GenerateToken {
     tokenId?: string;
 }
 
+export interface GenerateTokenResult {
+    entity?: Token;
+    jwt?: string;
+}
+
 /**
  * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
 
@@ -591,6 +615,18 @@ 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;
@@ -611,17 +647,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;
@@ -636,10 +684,6 @@ 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.
 
@@ -666,6 +710,15 @@ export interface GetPotentialDriversAbstract {
     weightInKg?: number;
 }
 
+/**
+ * @deprecated
+ */
+export interface GetPotentialRides {
+    accountId?: string;
+    maxSize?: number;
+    timeRange?: InstantRange;
+}
+
 export interface GetRide {
     rideId?: string;
 }
@@ -685,34 +738,29 @@ export interface GetRideLog {
     rideId?: string;
 }
 
-export interface GetRideOrSeries {
-    id?: string;
+export interface GetRideSeries {
+    rideSeriesId?: string;
 }
 
-export interface GetRidesForDriver {
+export interface GetRideSeriesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetRidesInMarketplace {
+export interface GetRidesForDriver {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetSeriesForDriver {
+export interface GetRidesInMarketplace {
     accountId?: string;
     maxSize?: number;
     timeRange?: InstantRange;
 }
 
-export interface GetSeriesInMarketplace {
-    accountId?: string;
-    maxSize?: number;
-}
-
-export interface GetSplitRideSeries {
+export interface GetRidesInSeries {
     filter?: RideFilter;
     rideSeriesId?: string;
 }
@@ -859,7 +907,7 @@ export interface ReadUpdates {
     maxSize?: number;
     maxTimeout?: number;
     tokenId?: string;
-    updateTypes?: EntityType[];
+    updateTypes?: TrackingUpdateType[];
 }
 
 export interface ReadUpdatesResult {
@@ -940,7 +988,7 @@ export interface ResetPosition {
 export interface ReturnRide extends RideDriverModifyCommand {
 }
 
-export interface ReturnRideSeries extends SeriesDriverCommand {
+export interface ReturnRideSeries extends RideDriverSeriesCommand {
 }
 
 export interface Review {
@@ -963,6 +1011,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
     drivePermissionId?: string;
 }
 
+export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
+}
+
 export interface RevokeSubscription extends AccountUpdate {
     subscriptionId?: string;
 }
@@ -970,7 +1021,7 @@ export interface RevokeSubscription extends AccountUpdate {
 export interface RevokeToken extends TokenUpdate {
 }
 
-export interface Ride extends RideOrSeries {
+export interface Ride {
     /**
      * Derived from driver != null
      */
@@ -1008,7 +1059,6 @@ export interface Ride extends RideOrSeries {
     driverReview?: Review;
     driverSyncStatus?: SyncStatus;
     endTimeDelay?: number;
-    entityType: "ride";
     /**
      * Expected Time of Arrival at the Destination/Drop-off location. 
      */
@@ -1047,6 +1097,9 @@ export interface Ride extends RideOrSeries {
 export interface RideBookerCommand extends RideCommand {
 }
 
+export interface RideBookerSeriesCommand extends RideSeriesCommand {
+}
+
 export interface RideCommand {
     rideId?: string;
 }
@@ -1057,6 +1110,9 @@ export interface RideDriverCommand extends RideCommand {
 export interface RideDriverModifyCommand extends RideDriverCommand {
 }
 
+export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
+}
+
 /**
  * All durations in seconds
  */
@@ -1072,7 +1128,6 @@ export interface RideFilter {
     driveStatuses?: DriveStatus[];
     driverAccountNames?: string[];
     driverTeamNames?: string[];
-    entityType?: EntityType;
     hasInfection?: boolean;
     heavyWeight?: boolean;
     mobilities?: Mobility[];
@@ -1112,8 +1167,38 @@ export interface RideIdResult {
 /**
  * Information about the ride, from the creator of the ride
  */
-export interface RideInfo extends GenericRideInfo {
+export interface RideInfo {
+    ambulanceInfo?: AmbulanceInfo;
     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 {
@@ -1139,41 +1224,37 @@ export interface RideOfferInfo {
 export interface RideOperatorCommand extends RideCommand {
 }
 
-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;
@@ -1205,19 +1286,19 @@ export interface RideUpdate {
     type: "ride";
 }
 
-export interface Role {
+export interface Role<T> {
 }
 
 /**
  * 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 {
-    info?: GenericRideInfo;
-    rides?: SingleRide[];
+export interface SecondaryTokenPermissionCommand extends TokenUpdate {
+    accountId?: string;
 }
 
 export interface SendConfirmationEmail {
@@ -1244,27 +1325,12 @@ 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.
  */
 export interface SeriesInfo {
-    positionInSeries?: number;
     returnTrip?: boolean;
     rideSeriesId?: string;
-    totalRidesInSeries?: number;
 }
 
 export interface SetOperateAccounts extends AccountUpdate {
@@ -1275,6 +1341,10 @@ export interface SetOperator extends AccountUpdate {
     operator?: string;
 }
 
+export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
+    accountPermission?: AccountPermission;
+}
+
 export interface SetSettings extends AccountUpdate {
     settings?: any;
 }
@@ -1303,15 +1373,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 {
@@ -1363,10 +1434,11 @@ export interface TimedPermission {
 }
 
 export interface Token {
-    accountPermission?: AccountPermission;
+    accountPermissions?: AccountPermission[];
     createdBy?: string;
     info?: TokenInfo;
     lastUpdatedBy?: string;
+    owner?: string;
     revoked?: boolean;
     tokenId?: string;
 }
@@ -1409,8 +1481,7 @@ export interface UpdateRidePlan extends RideDriverModifyCommand {
     plannedStartTime?: string;
 }
 
-export interface UpdateRideSeries extends SeriesBookerModifyCommand {
-    booker?: AccountOrTeamRef;
+export interface UpdateRideSeries extends RideBookerSeriesCommand {
     info?: GenericRideInfo;
     rides?: SingleRide[];
 }
@@ -1481,8 +1552,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";
@@ -1493,11 +1562,11 @@ 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" | "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";
 
@@ -1507,6 +1576,8 @@ 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.1501-test-server",
+  "version": "0.1.1532-test-server",
   "types": "common.d.ts"
 }