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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/common.d.ts CHANGED
@@ -1,6 +1,10 @@
1
1
 
2
- export interface AcceptDrive extends FleetCommand {
3
- driveOwner?: AccountOrTeamRef;
2
+ export interface AcceptRide extends RideDriverCommand {
3
+ driver?: AccountOrTeamRef;
4
+ }
5
+
6
+ export interface AcceptRideSeries extends RideDriverSeriesCommand {
7
+ driver?: AccountOrTeamRef;
4
8
  }
5
9
 
6
10
  export interface AcceptUserAgreement extends UserEdit {
@@ -9,6 +13,10 @@ export interface AcceptUserAgreement extends UserEdit {
9
13
 
10
14
  export interface Account {
11
15
  accountId?: string;
16
+ /**
17
+ * Derived from subscriptions
18
+ */
19
+ activeOrganisationTypes?: OrganisationType[];
12
20
  /**
13
21
  * Derived from subscriptions
14
22
  */
@@ -18,6 +26,12 @@ export interface Account {
18
26
  drivePermissions?: DrivePermission[];
19
27
  info?: AccountInfo;
20
28
  integrationSettings?: any[];
29
+ operateAccounts?: string[];
30
+ operator?: string;
31
+ /**
32
+ * Derived from subscriptions. Includes organisation types that have not been confirmed yet by a superadmin or are active in past or future.
33
+ */
34
+ organisationTypes?: OrganisationType[];
21
35
  subscriptions?: Subscription[];
22
36
  teams?: Team[];
23
37
  unconfirmedCriticalInfo?: CriticalAccountInfo;
@@ -27,11 +41,16 @@ export interface AccountCommand {
27
41
  accountId?: string;
28
42
  }
29
43
 
44
+ export interface AccountFilter {
45
+ activeServices?: Service[];
46
+ }
47
+
30
48
  export interface AccountInfo {
31
49
  address?: AddressInfo;
32
50
  defaultLanguage?: string;
33
51
  notificationEmails?: string[];
34
52
  phoneNumber?: PhoneNumber;
53
+ zoneId?: string;
35
54
  }
36
55
 
37
56
  export interface AccountOrTeamId {
@@ -59,6 +78,9 @@ export interface AccountRef {
59
78
  name?: string;
60
79
  }
61
80
 
81
+ export interface AccountUpcaster {
82
+ }
83
+
62
84
  export interface AccountUpdate extends AccountCommand {
63
85
  }
64
86
 
@@ -97,13 +119,13 @@ export interface AdminSetUserPassword {
97
119
  userId?: string;
98
120
  }
99
121
 
100
- export interface AmbulanceFilter extends RideTypeSpecificFilter {
122
+ export interface AmbulanceFilter extends DrivePermissionFilter {
101
123
  heavyWeightAllowed?: boolean;
102
124
  type: "ambulance";
103
125
  }
104
126
 
105
127
  /**
106
- * Filled if (and only if) rideType == ambulance
128
+ * Filled if (and only if) vehicleType == ambulance
107
129
  */
108
130
  export interface AmbulanceInfo {
109
131
  /**
@@ -124,13 +146,26 @@ export interface AmbulanceInfo {
124
146
  requiresSuctionAspirator?: boolean;
125
147
  }
126
148
 
149
+ /**
150
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
151
+
152
+ */
153
+ export interface AnonymizedGenericRideInfo extends GenericRideInfo {
154
+ }
155
+
156
+ /**
157
+ * Information about the ride, from the creator of the ride
158
+ */
159
+ export interface AnonymizedRideInfo extends RideInfo {
160
+ }
161
+
127
162
  export interface Appointment {
128
163
  pickup?: boolean;
129
164
  time?: string;
130
165
  }
131
166
 
132
- export interface AssignDriver extends RideCommand {
133
- driveOwner?: AccountOrTeamRef;
167
+ export interface AssignDriver extends RideOperatorCommand {
168
+ driver?: AccountOrTeamRef;
134
169
  }
135
170
 
136
171
  export interface Attachment {
@@ -154,18 +189,38 @@ export interface AuthenticationResponse {
154
189
  export interface AuthenticationService {
155
190
  }
156
191
 
192
+ export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
193
+ info?: GenericRideInfo;
194
+ updater?: AccountOrTeamRef;
195
+ }
196
+
197
+ export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
198
+ rides?: SingleRideUpdate[];
199
+ updater?: AccountOrTeamRef;
200
+ }
201
+
157
202
  export interface BookRide extends CreateRideCommand {
203
+ booker?: AccountOrTeamRef;
158
204
  info?: RideInfo;
159
- owner?: AccountOrTeamRef;
160
205
  }
161
206
 
162
- export interface CancelDrive extends FleetModifyCommand {
207
+ export interface BookRideSeries extends RideBookerSeriesCommand {
208
+ booker?: AccountOrTeamRef;
209
+ info?: GenericRideInfo;
210
+ rides?: SingleRide[];
163
211
  }
164
212
 
165
- export interface CancelRide extends RidePlannerCommand {
213
+ export interface CancelRide extends RideBookerCommand {
166
214
  reason?: string;
167
215
  }
168
216
 
217
+ export interface CancelRideSeries extends RideBookerSeriesCommand {
218
+ }
219
+
220
+ export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
221
+ updater?: AccountOrTeamRef;
222
+ }
223
+
169
224
  export interface CeliosSettings {
170
225
  certificate?: string;
171
226
  host?: string;
@@ -217,8 +272,27 @@ export interface CreateAccount extends AccountCommand {
217
272
  requestService?: StandaloneService;
218
273
  }
219
274
 
220
- export interface CreateRideCommand extends RidePlannerCommand {
221
- owner?: AccountOrTeamId;
275
+ export interface CreateOptimizationPlan extends OptimizerMessage {
276
+ accountOrTeam?: AccountOrTeamRef;
277
+ timeRange?: InstantRange;
278
+ }
279
+
280
+ export interface CreateRideCommand extends RideBookerCommand {
281
+ booker?: AccountOrTeamId;
282
+ }
283
+
284
+ export interface CreateRideFromSeries extends RideDriverCommand {
285
+ booker?: AccountOrTeamRef;
286
+ driver?: AccountOrTeamRef;
287
+ info?: RideInfo;
288
+ seriesInfo?: SeriesInfo;
289
+ }
290
+
291
+ export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
292
+ }
293
+
294
+ export interface CreateSqueezeInPlan extends OptimizerMessage {
295
+ accountOrTeam?: AccountOrTeamRef;
222
296
  }
223
297
 
224
298
  export interface CreateTeam extends AccountCommand {
@@ -250,6 +324,11 @@ export interface DateRange {
250
324
  export interface DeleteUser extends UserEdit {
251
325
  }
252
326
 
327
+ export interface DisconnectClient {
328
+ clientId?: string;
329
+ tokenId?: string;
330
+ }
331
+
253
332
  export interface DispoliveSettings {
254
333
  key?: string;
255
334
  type: "dispolive";
@@ -282,14 +361,18 @@ export interface DrivePermission {
282
361
  revoked?: boolean;
283
362
  }
284
363
 
364
+ export interface DrivePermissionFilter {
365
+ type: "ambulance" | "taxi";
366
+ }
367
+
285
368
  export interface DrivePermissionInfo {
286
- filter?: RideTypeSpecificFilterUnion;
369
+ filter?: DrivePermissionFilterUnion;
287
370
  monopoly?: boolean;
288
371
  regions?: Region[];
289
372
  }
290
373
 
291
374
  export interface DrivePermissionInfoRequest {
292
- filter?: RideTypeSpecificFilterUnion;
375
+ filter?: DrivePermissionFilterUnion;
293
376
  regions?: Region[];
294
377
  }
295
378
 
@@ -339,10 +422,32 @@ export interface FetchRouteResult {
339
422
  duration?: number;
340
423
  }
341
424
 
425
+ /**
426
+ * @deprecated
427
+ */
342
428
  export interface FindAccount {
343
429
  term?: string;
344
430
  }
345
431
 
432
+ export interface FindAccounts {
433
+ filter?: AccountFilter;
434
+ term?: string;
435
+ }
436
+
437
+ /**
438
+ * @deprecated
439
+ */
440
+ export interface FindMyAcceptedRides {
441
+ accountId?: string;
442
+ descending?: boolean;
443
+ filter?: RideFilter;
444
+ maxSize?: number;
445
+ term?: string;
446
+ }
447
+
448
+ /**
449
+ * @deprecated
450
+ */
346
451
  export interface FindMyRideOffers {
347
452
  accountId?: string;
348
453
  descending?: boolean;
@@ -351,6 +456,14 @@ export interface FindMyRideOffers {
351
456
  term?: string;
352
457
  }
353
458
 
459
+ export interface FindMyRideSeries {
460
+ accountId?: string;
461
+ descending?: boolean;
462
+ maxSize?: number;
463
+ term?: string;
464
+ timeRange?: InstantRange;
465
+ }
466
+
354
467
  export interface FindMyRides {
355
468
  accountId?: string;
356
469
  descending?: boolean;
@@ -371,6 +484,16 @@ export interface FindMyUsers {
371
484
  term?: string;
372
485
  }
373
486
 
487
+ export interface FindPotentialRideSeries {
488
+ accountId?: string;
489
+ descending?: boolean;
490
+ filter?: RideInfoFilter;
491
+ maxSize?: number;
492
+ }
493
+
494
+ /**
495
+ * @deprecated
496
+ */
374
497
  export interface FindPotentialRides {
375
498
  accountId?: string;
376
499
  descending?: boolean;
@@ -386,6 +509,22 @@ export interface FindRides {
386
509
  term?: string;
387
510
  }
388
511
 
512
+ export interface FindRidesForDriver {
513
+ accountId?: string;
514
+ descending?: boolean;
515
+ filter?: RideFilter;
516
+ maxSize?: number;
517
+ term?: string;
518
+ }
519
+
520
+ export interface FindRidesInMarketplace {
521
+ accountId?: string;
522
+ descending?: boolean;
523
+ filter?: RideFilter;
524
+ maxSize?: number;
525
+ term?: string;
526
+ }
527
+
389
528
  export interface FindRidesResult {
390
529
  count?: RideFilterCount;
391
530
  rides?: Ride[];
@@ -399,18 +538,37 @@ export interface FindUsers {
399
538
  term?: string;
400
539
  }
401
540
 
402
- export interface FleetCommand extends RideCommand {
403
- }
404
-
405
- export interface FleetModifyCommand extends FleetCommand {
406
- }
407
-
408
541
  export interface GenerateToken {
409
542
  accountPermission?: AccountPermission;
410
543
  info?: TokenInfo;
411
544
  tokenId?: string;
412
545
  }
413
546
 
547
+ /**
548
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
549
+
550
+ */
551
+ export interface GenericRideInfo {
552
+ ambulanceInfo?: AmbulanceInfo;
553
+ attendantsPresent?: number;
554
+ comment?: string;
555
+ dimensions?: PersonDimensions;
556
+ distanceInMeters?: number;
557
+ from?: AddressInfo;
558
+ /**
559
+ * Derived from weightInKg != null
560
+ */
561
+ heavyWeight?: boolean;
562
+ mobility?: Mobility;
563
+ patient?: Person;
564
+ plannedDuration?: RideDuration;
565
+ preferredDriver?: string;
566
+ purpose?: RidePurpose;
567
+ to?: AddressInfo;
568
+ vehicleType?: VehicleType;
569
+ weightInKg?: number;
570
+ }
571
+
414
572
  export interface GeoJson {
415
573
  features?: Feature[];
416
574
  }
@@ -441,10 +599,28 @@ export interface GetAccount {
441
599
  accountId?: string;
442
600
  }
443
601
 
444
- export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
602
+ /**
603
+ * @deprecated
604
+ */
605
+ export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
445
606
  }
446
607
 
447
- export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
608
+ /**
609
+ * @deprecated
610
+ */
611
+ export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
612
+ }
613
+
614
+ export interface GetAllRideSeriesForDriver {
615
+ accountId?: string;
616
+ descending?: boolean;
617
+ maxSize?: number;
618
+ timeRange?: InstantRange;
619
+ }
620
+
621
+ export interface GetAllRideSeriesInMarketplace {
622
+ accountId?: string;
623
+ maxSize?: number;
448
624
  }
449
625
 
450
626
  export interface GetDistrict {
@@ -467,9 +643,22 @@ export interface GetIsoStates {
467
643
  export interface GetMonopolyAccounts {
468
644
  }
469
645
 
646
+ /**
647
+ * @deprecated
648
+ */
649
+ export interface GetMyAcceptedRides {
650
+ accountId?: string;
651
+ maxSize?: number;
652
+ timeRange?: InstantRange;
653
+ }
654
+
470
655
  export interface GetMyAccounts {
656
+ filter?: AccountFilter;
471
657
  }
472
658
 
659
+ /**
660
+ * @deprecated
661
+ */
473
662
  export interface GetMyRideOffers {
474
663
  accountId?: string;
475
664
  maxSize?: number;
@@ -491,14 +680,35 @@ export interface GetMyUserProfile {
491
680
  export interface GetNutsStates {
492
681
  }
493
682
 
494
- export interface GetPotentialDrivers {
683
+ /**
684
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
685
+
686
+ */
687
+ export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
688
+ }
689
+
690
+ /**
691
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
692
+
693
+ */
694
+ export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
695
+ }
696
+
697
+ /**
698
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
699
+
700
+ */
701
+ export interface GetPotentialDriversAbstract {
495
702
  fromDistrict?: string;
496
703
  mobility?: Mobility;
497
- rideType?: RideType;
498
704
  toDistrict?: string;
705
+ vehicleType?: VehicleType;
499
706
  weightInKg?: number;
500
707
  }
501
708
 
709
+ /**
710
+ * @deprecated
711
+ */
502
712
  export interface GetPotentialRides {
503
713
  accountId?: string;
504
714
  maxSize?: number;
@@ -512,14 +722,45 @@ export interface GetRide {
512
722
  export interface GetRideCsv extends RideStatisticsQuery {
513
723
  }
514
724
 
515
- export interface GetRideData extends RideStatisticsQuery {
516
- rideOwner?: string;
725
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
726
+ accountId?: string;
727
+ }
728
+
729
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
730
+ accountId?: string;
517
731
  }
518
732
 
519
733
  export interface GetRideLog {
520
734
  rideId?: string;
521
735
  }
522
736
 
737
+ export interface GetRideSeries {
738
+ rideSeriesId?: string;
739
+ }
740
+
741
+ export interface GetRideSeriesForDriver {
742
+ accountId?: string;
743
+ maxSize?: number;
744
+ timeRange?: InstantRange;
745
+ }
746
+
747
+ export interface GetRidesForDriver {
748
+ accountId?: string;
749
+ maxSize?: number;
750
+ timeRange?: InstantRange;
751
+ }
752
+
753
+ export interface GetRidesInMarketplace {
754
+ accountId?: string;
755
+ maxSize?: number;
756
+ timeRange?: InstantRange;
757
+ }
758
+
759
+ export interface GetRidesInSeries {
760
+ filter?: RideFilter;
761
+ rideSeriesId?: string;
762
+ }
763
+
523
764
  export interface GetTeam {
524
765
  teamId?: string;
525
766
  }
@@ -546,6 +787,14 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
546
787
  teamPermission?: TeamPermission;
547
788
  }
548
789
 
790
+ export interface IGetPotentialDrivers {
791
+ fromDistrict?: string;
792
+ mobility?: Mobility;
793
+ toDistrict?: string;
794
+ vehicleType?: VehicleType;
795
+ weightInKg?: number;
796
+ }
797
+
549
798
  export interface ImpersonateUser {
550
799
  userId?: string;
551
800
  }
@@ -586,6 +835,16 @@ export interface IsoState {
586
835
  nutsCode?: string;
587
836
  }
588
837
 
838
+ export interface Metric {
839
+ clientId?: string;
840
+ clientSegment?: number[];
841
+ maxSize?: number;
842
+ maxTimeout?: string;
843
+ tokenId?: string;
844
+ type?: string;
845
+ updates?: string[];
846
+ }
847
+
589
848
  export interface NutsDistrict {
590
849
  code?: string;
591
850
  name?: string;
@@ -608,6 +867,9 @@ export interface OffsetTimeRange {
608
867
  start?: Date;
609
868
  }
610
869
 
870
+ export interface OptimizerMessage {
871
+ }
872
+
611
873
  export interface Person {
612
874
  address?: AddressInfo;
613
875
  birthDay?: string;
@@ -632,6 +894,24 @@ export interface PersonDimensions {
632
894
  export interface PhoneNumber {
633
895
  }
634
896
 
897
+ export interface PlanRide extends RideDriverModifyCommand {
898
+ plannedStartTime?: string;
899
+ }
900
+
901
+ export interface ReadUpdates {
902
+ clientId?: string;
903
+ maxSize?: number;
904
+ maxTimeout?: number;
905
+ tokenId?: string;
906
+ updateTypes?: TrackingUpdateType[];
907
+ }
908
+
909
+ export interface ReadUpdatesResult {
910
+ clientSegment?: number[];
911
+ lastIndex?: number;
912
+ updates?: any[];
913
+ }
914
+
635
915
  export interface Region {
636
916
  nutsCode?: string;
637
917
  }
@@ -640,16 +920,11 @@ export interface RegisterAuthenticationToken extends UserUpdate {
640
920
  hashedToken?: string;
641
921
  }
642
922
 
643
- export interface RegisterDifferentEta extends FleetModifyCommand {
644
- destinationEta?: string;
645
- originEta?: string;
646
- }
647
-
648
- export interface RegisterDriveStatus extends FleetModifyCommand {
923
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
649
924
  driveStatus?: DriveStatus;
650
925
  }
651
926
 
652
- export interface RegisterDriverSynced extends FleetModifyCommand {
927
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
653
928
  }
654
929
 
655
930
  export interface RegisterEinsatz {
@@ -676,6 +951,13 @@ export interface ReportIssue {
676
951
  issue?: string;
677
952
  }
678
953
 
954
+ /**
955
+ * Can only report delays when ride has started and has not arrived at destination.
956
+ */
957
+ export interface ReportRideDelay extends RideDriverModifyCommand {
958
+ minutes?: number;
959
+ }
960
+
679
961
  export interface RequestDrivePermission extends AccountUpdate {
680
962
  drivePermissionId?: string;
681
963
  info?: DrivePermissionInfoRequest;
@@ -690,6 +972,34 @@ export interface RequestUserReset {
690
972
  email?: string;
691
973
  }
692
974
 
975
+ /**
976
+ * Resets the lastIndex position of your token.
977
+ */
978
+ export interface ResetPosition {
979
+ index?: number;
980
+ timestamp?: string;
981
+ tokenId?: string;
982
+ }
983
+
984
+ export interface ReturnRide extends RideDriverModifyCommand {
985
+ }
986
+
987
+ export interface ReturnRideSeries extends RideDriverSeriesCommand {
988
+ }
989
+
990
+ export interface Review {
991
+ comment?: string;
992
+ stars?: number;
993
+ }
994
+
995
+ export interface ReviewRideAsBooker extends RideBookerCommand {
996
+ review?: Review;
997
+ }
998
+
999
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
1000
+ review?: Review;
1001
+ }
1002
+
693
1003
  export interface RevokeAccountPermission extends AccountPermissionCommand {
694
1004
  }
695
1005
 
@@ -706,14 +1016,22 @@ export interface RevokeToken extends TokenUpdate {
706
1016
 
707
1017
  export interface Ride {
708
1018
  /**
709
- * Derived from driveOwner != null
1019
+ * Derived from driver != null
710
1020
  */
711
1021
  accepted?: boolean;
1022
+ actualEndTime?: string;
1023
+ actualStartTime?: string;
1024
+ /**
1025
+ * Derived from driveStatus != null
1026
+ */
1027
+ arrived?: boolean;
712
1028
  /**
713
1029
  * Derived from bookedTime != null
714
1030
  */
715
1031
  booked?: boolean;
716
1032
  bookedTime?: string;
1033
+ booker?: AccountOrTeamRef;
1034
+ bookerReview?: Review;
717
1035
  bookingStatus?: BookingStatus;
718
1036
  cancelReason?: string;
719
1037
  cancelled?: boolean;
@@ -722,37 +1040,72 @@ export interface Ride {
722
1040
  */
723
1041
  completed?: boolean;
724
1042
  /**
725
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
1043
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
726
1044
  */
727
- destinationEta?: string;
1045
+ desiredEndTime?: string;
728
1046
  /**
729
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1047
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
730
1048
  */
731
- destinationPta?: string;
732
- driveOwner?: AccountOrTeamRef;
1049
+ desiredStartTime?: string;
733
1050
  driveStatus?: DriveStatus;
1051
+ driver?: AccountOrTeamRef;
1052
+ driverReview?: Review;
734
1053
  driverSyncStatus?: SyncStatus;
1054
+ endTimeDelay?: number;
1055
+ /**
1056
+ * Expected Time of Arrival at the Destination/Drop-off location.
1057
+ */
1058
+ expectedEndTime?: string;
1059
+ /**
1060
+ * Expected Time of Arrival at the Origin/Pick-up location.
1061
+ */
1062
+ expectedStartTime?: string;
735
1063
  info?: RideInfo;
736
1064
  /**
737
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
1065
+ * Derived from plannedStartTime != null
738
1066
  */
739
- originEta?: string;
1067
+ planned?: boolean;
740
1068
  /**
741
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1069
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
742
1070
  */
743
- originPta?: string;
1071
+ plannedEndTime?: string;
1072
+ plannedStartTime?: string;
744
1073
  rideId?: string;
745
- rideOwner?: AccountOrTeamRef;
1074
+ /**
1075
+ * The time until which rides can be found. It's the planned time or else the desired time.
1076
+ */
1077
+ searchEndTime?: string;
1078
+ /**
1079
+ * The time from which rides can be found. It's the planned time or else the desired time.
1080
+ */
1081
+ searchStartTime?: string;
1082
+ seriesInfo?: SeriesInfo;
1083
+ startTimeDelay?: number;
746
1084
  /**
747
1085
  * Derived from driveStatus != null
748
1086
  */
749
1087
  started?: boolean;
750
1088
  }
751
1089
 
1090
+ export interface RideBookerCommand extends RideCommand {
1091
+ }
1092
+
1093
+ export interface RideBookerSeriesCommand extends RideSeriesCommand {
1094
+ }
1095
+
752
1096
  export interface RideCommand {
753
1097
  rideId?: string;
754
1098
  }
755
1099
 
1100
+ export interface RideDriverCommand extends RideCommand {
1101
+ }
1102
+
1103
+ export interface RideDriverModifyCommand extends RideDriverCommand {
1104
+ }
1105
+
1106
+ export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
1107
+ }
1108
+
756
1109
  /**
757
1110
  * All durations in seconds
758
1111
  */
@@ -765,38 +1118,39 @@ export interface RideDuration {
765
1118
 
766
1119
  export interface RideFilter {
767
1120
  bookingStatuses?: BookingStatus[];
768
- directions?: Direction[];
769
1121
  driveStatuses?: DriveStatus[];
770
1122
  driverAccountNames?: string[];
771
1123
  driverTeamNames?: string[];
772
1124
  hasInfection?: boolean;
773
1125
  heavyWeight?: boolean;
774
1126
  mobilities?: Mobility[];
1127
+ purposes?: RidePurpose[];
1128
+ region?: Region;
775
1129
  requiresMonitoring?: boolean;
776
1130
  requiresOxygen?: boolean;
777
1131
  requiresSuctionAspirator?: boolean;
778
- rideType?: RideType;
779
1132
  riderAccountNames?: string[];
780
1133
  riderTeamNames?: string[];
781
1134
  timeRange?: InstantRange;
1135
+ vehicleType?: VehicleType;
782
1136
  }
783
1137
 
784
1138
  export interface RideFilterCount {
785
1139
  bookingStatuses?: { [P in BookingStatus]?: number };
786
- directions?: { [P in Direction]?: number };
787
1140
  driveStatuses?: { [P in DriveStatus]?: number };
788
1141
  driverAccountNames?: { [index: string]: number };
789
1142
  driverTeamNames?: { [index: string]: number };
790
1143
  hasInfection?: number;
791
1144
  heavyWeight?: number;
792
1145
  mobilities?: { [P in Mobility]?: number };
1146
+ purposes?: { [P in RidePurpose]?: number };
793
1147
  requiresMonitoring?: number;
794
1148
  requiresOxygen?: number;
795
1149
  requiresSuctionAspirator?: number;
796
- rideTypes?: { [P in RideType]?: number };
797
1150
  riderAccountNames?: { [index: string]: number };
798
1151
  riderTeamNames?: { [index: string]: number };
799
1152
  total?: number;
1153
+ vehicleTypes?: { [P in VehicleType]?: number };
800
1154
  }
801
1155
 
802
1156
  export interface RideIdResult {
@@ -812,7 +1166,6 @@ export interface RideInfo {
812
1166
  attendantsPresent?: number;
813
1167
  comment?: string;
814
1168
  dimensions?: PersonDimensions;
815
- direction?: Direction;
816
1169
  distanceInMeters?: number;
817
1170
  from?: AddressInfo;
818
1171
  /**
@@ -823,11 +1176,24 @@ export interface RideInfo {
823
1176
  patient?: Person;
824
1177
  plannedDuration?: RideDuration;
825
1178
  preferredDriver?: string;
826
- rideType?: RideType;
1179
+ purpose?: RidePurpose;
827
1180
  to?: AddressInfo;
1181
+ vehicleType?: VehicleType;
828
1182
  weightInKg?: number;
829
1183
  }
830
1184
 
1185
+ export interface RideInfoFilter {
1186
+ hasInfection?: boolean;
1187
+ heavyWeight?: boolean;
1188
+ mobilities?: Mobility[];
1189
+ purposes?: RidePurpose[];
1190
+ region?: Region;
1191
+ requiresMonitoring?: boolean;
1192
+ requiresOxygen?: boolean;
1193
+ requiresSuctionAspirator?: boolean;
1194
+ vehicleType?: VehicleType;
1195
+ }
1196
+
831
1197
  export interface RideLog {
832
1198
  actingFor?: AccountOrTeamRef;
833
1199
  allowedViewers?: AccountOrTeamRef[];
@@ -848,15 +1214,69 @@ export interface RideOfferInfo {
848
1214
  appointment?: Appointment;
849
1215
  }
850
1216
 
851
- export interface RidePlannerCommand extends RideCommand {
1217
+ export interface RideOperatorCommand extends RideCommand {
1218
+ }
1219
+
1220
+ export interface RideSeries {
1221
+ accepted?: boolean;
1222
+ booked?: boolean;
1223
+ booker?: AccountOrTeamRef;
1224
+ cancelled?: boolean;
1225
+ confirmed?: boolean;
1226
+ driver?: AccountOrTeamRef;
1227
+ endTime?: string;
1228
+ info?: GenericRideInfo;
1229
+ rideSeriesId?: string;
1230
+ rides?: SingleRide[];
1231
+ startTime?: string;
1232
+ status?: RideSeriesStatus;
1233
+ }
1234
+
1235
+ export interface RideSeriesCommand {
1236
+ rideSeriesId?: string;
1237
+ }
1238
+
1239
+ export interface RideSeriesIdResult {
1240
+ rideSeriesId?: string;
1241
+ }
1242
+
1243
+ export interface RideSeriesPostConfirmCommand {
1244
+ rideSeriesId?: string;
1245
+ ridesToModify?: Ride[];
1246
+ }
1247
+
1248
+ export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
1249
+ }
1250
+
1251
+ export interface RideSeriesUpdate {
1252
+ after?: RideSeries;
1253
+ before?: RideSeries;
1254
+ entityId?: string;
1255
+ eventType?: string;
1256
+ index?: number;
1257
+ timestamp?: string;
1258
+ type: "rideseries";
852
1259
  }
853
1260
 
854
1261
  export interface RideStatisticsQuery {
855
1262
  dateRange?: DateRange;
1263
+ zoneId?: string;
856
1264
  }
857
1265
 
858
- export interface RideTypeSpecificFilter {
859
- type: "ambulance" | "taxi";
1266
+ export interface RideSystemCommand extends RideCommand {
1267
+ }
1268
+
1269
+ export interface RideUpcaster {
1270
+ }
1271
+
1272
+ export interface RideUpdate {
1273
+ after?: Ride;
1274
+ before?: Ride;
1275
+ entityId?: string;
1276
+ eventType?: string;
1277
+ index?: number;
1278
+ timestamp?: string;
1279
+ type: "ride";
860
1280
  }
861
1281
 
862
1282
  export interface Role<T> {
@@ -866,8 +1286,8 @@ export interface Role<T> {
866
1286
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
867
1287
  */
868
1288
  export interface SaveRide extends CreateRideCommand {
1289
+ booker?: AccountOrTeamRef;
869
1290
  info?: RideInfo;
870
- owner?: AccountOrTeamRef;
871
1291
  }
872
1292
 
873
1293
  export interface SendConfirmationEmail {
@@ -893,6 +1313,22 @@ export interface SendSlack {
893
1313
  message?: string;
894
1314
  }
895
1315
 
1316
+ /**
1317
+ * Information about a ride that is part of series.
1318
+ */
1319
+ export interface SeriesInfo {
1320
+ returnTrip?: boolean;
1321
+ rideSeriesId?: string;
1322
+ }
1323
+
1324
+ export interface SetOperateAccounts extends AccountUpdate {
1325
+ operateAccounts?: string[];
1326
+ }
1327
+
1328
+ export interface SetOperator extends AccountUpdate {
1329
+ operator?: string;
1330
+ }
1331
+
896
1332
  export interface SetSettings extends AccountUpdate {
897
1333
  settings?: any;
898
1334
  }
@@ -920,6 +1356,19 @@ export interface SignUpUser {
920
1356
  userId?: string;
921
1357
  }
922
1358
 
1359
+ /**
1360
+ * Individual ride timing within a series
1361
+ */
1362
+ export interface SingleRide {
1363
+ desiredStartTime?: string;
1364
+ returnTrip?: boolean;
1365
+ }
1366
+
1367
+ export interface SingleRideUpdate {
1368
+ desiredStartTime?: string;
1369
+ rideId?: string;
1370
+ }
1371
+
923
1372
  export interface StopImpersonatingUser {
924
1373
  }
925
1374
 
@@ -933,7 +1382,7 @@ export interface SubscriptionInfo extends TimedPermission {
933
1382
  service?: Service;
934
1383
  }
935
1384
 
936
- export interface TaxiFilter extends RideTypeSpecificFilter {
1385
+ export interface TaxiFilter extends DrivePermissionFilter {
937
1386
  allowedMobilities?: Mobility[];
938
1387
  type: "taxi";
939
1388
  }
@@ -1000,9 +1449,24 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1000
1449
  accountPermission?: AccountPermission;
1001
1450
  }
1002
1451
 
1003
- export interface UpdateRideBooking extends RidePlannerCommand {
1452
+ export interface UpdatePosition {
1453
+ clientSegment?: number[];
1454
+ lastIndex?: number;
1455
+ tokenId?: string;
1456
+ }
1457
+
1458
+ export interface UpdateRide extends RideBookerCommand {
1459
+ booker?: AccountOrTeamRef;
1004
1460
  info?: RideInfo;
1005
- owner?: AccountOrTeamRef;
1461
+ }
1462
+
1463
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1464
+ plannedStartTime?: string;
1465
+ }
1466
+
1467
+ export interface UpdateRideSeries extends RideBookerSeriesCommand {
1468
+ info?: GenericRideInfo;
1469
+ rides?: SingleRide[];
1006
1470
  }
1007
1471
 
1008
1472
  export interface UpdateTeam extends TeamUpdate {
@@ -1018,6 +1482,9 @@ export interface UpdateUserInfo extends UserEdit {
1018
1482
  info?: UserInfo;
1019
1483
  }
1020
1484
 
1485
+ export interface UserAndTokenUpcaster {
1486
+ }
1487
+
1021
1488
  export interface UserCommand {
1022
1489
  userId?: string;
1023
1490
  }
@@ -1029,7 +1496,7 @@ export interface UserInfo {
1029
1496
  firstName?: string;
1030
1497
  language?: string;
1031
1498
  lastName?: string;
1032
- telephoneNumber?: string;
1499
+ telephoneNumber?: PhoneNumber;
1033
1500
  }
1034
1501
 
1035
1502
  export interface UserOrTokenId {
@@ -1058,13 +1525,13 @@ export interface ZonedTimeRange {
1058
1525
  start?: Date;
1059
1526
  }
1060
1527
 
1061
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1528
+ export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
1062
1529
 
1063
1530
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1064
1531
 
1065
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1532
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1066
1533
 
1067
- export type Direction = "admission" | "relocation" | "discharge";
1534
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1068
1535
 
1069
1536
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1070
1537
 
@@ -1074,20 +1541,26 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
1074
1541
 
1075
1542
  export type IntegrationType = "dispolive" | "celios";
1076
1543
 
1077
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1544
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1545
+
1546
+ export type OrganisationType = "medical" | "fleet" | "operator";
1078
1547
 
1079
- export type RideType = "taxi" | "ambulance";
1548
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1080
1549
 
1081
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1550
+ export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
1082
1551
 
1083
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1552
+ export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration";
1084
1553
 
1085
1554
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1086
1555
 
1087
- export type StandaloneService = "rideplanning" | "driveplanning";
1556
+ export type StandaloneService = "pro_medical" | "pro_fleet" | "pro_operator";
1088
1557
 
1089
1558
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1090
1559
 
1091
- export type TeamRole = "driveplanner" | "rideplanner";
1560
+ export type TeamRole = "dispatcher" | "ridebooker";
1561
+
1562
+ export type TrackingUpdateType = "ride" | "rideseries";
1092
1563
 
1093
1564
  export type UserRole = "superadmin";
1565
+
1566
+ export type VehicleType = "taxi" | "ambulance";
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@moxi.gmbh/moxi-typescriptmodels",
3
- "version": "0.1.581-test-server",
3
+ "version": "0.1.581",
4
4
  "types": "common.d.ts"
5
5
  }
File without changes