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

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;
@@ -361,7 +474,6 @@ export interface FindMyRides {
361
474
 
362
475
  export interface FindMyTokens {
363
476
  accountId?: string;
364
- teamId?: string;
365
477
  term?: string;
366
478
  }
367
479
 
@@ -371,6 +483,16 @@ export interface FindMyUsers {
371
483
  term?: string;
372
484
  }
373
485
 
486
+ export interface FindPotentialRideSeries {
487
+ accountId?: string;
488
+ descending?: boolean;
489
+ filter?: RideInfoFilter;
490
+ maxSize?: number;
491
+ }
492
+
493
+ /**
494
+ * @deprecated
495
+ */
374
496
  export interface FindPotentialRides {
375
497
  accountId?: string;
376
498
  descending?: boolean;
@@ -386,6 +508,22 @@ export interface FindRides {
386
508
  term?: string;
387
509
  }
388
510
 
511
+ export interface FindRidesForDriver {
512
+ accountId?: string;
513
+ descending?: boolean;
514
+ filter?: RideFilter;
515
+ maxSize?: number;
516
+ term?: string;
517
+ }
518
+
519
+ export interface FindRidesInMarketplace {
520
+ accountId?: string;
521
+ descending?: boolean;
522
+ filter?: RideFilter;
523
+ maxSize?: number;
524
+ term?: string;
525
+ }
526
+
389
527
  export interface FindRidesResult {
390
528
  count?: RideFilterCount;
391
529
  rides?: Ride[];
@@ -399,18 +537,42 @@ export interface FindUsers {
399
537
  term?: string;
400
538
  }
401
539
 
402
- export interface FleetCommand extends RideCommand {
403
- }
404
-
405
- export interface FleetModifyCommand extends FleetCommand {
406
- }
407
-
408
540
  export interface GenerateToken {
409
541
  accountPermission?: AccountPermission;
410
542
  info?: TokenInfo;
411
543
  tokenId?: string;
412
544
  }
413
545
 
546
+ export interface GenerateTokenResult {
547
+ entity?: Token;
548
+ jwt?: string;
549
+ }
550
+
551
+ /**
552
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
553
+
554
+ */
555
+ export interface GenericRideInfo {
556
+ ambulanceInfo?: AmbulanceInfo;
557
+ attendantsPresent?: number;
558
+ comment?: string;
559
+ dimensions?: PersonDimensions;
560
+ distanceInMeters?: number;
561
+ from?: AddressInfo;
562
+ /**
563
+ * Derived from weightInKg != null
564
+ */
565
+ heavyWeight?: boolean;
566
+ mobility?: Mobility;
567
+ patient?: Person;
568
+ plannedDuration?: RideDuration;
569
+ preferredDriver?: string;
570
+ purpose?: RidePurpose;
571
+ to?: AddressInfo;
572
+ vehicleType?: VehicleType;
573
+ weightInKg?: number;
574
+ }
575
+
414
576
  export interface GeoJson {
415
577
  features?: Feature[];
416
578
  }
@@ -441,10 +603,28 @@ export interface GetAccount {
441
603
  accountId?: string;
442
604
  }
443
605
 
444
- export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
606
+ /**
607
+ * @deprecated
608
+ */
609
+ export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
610
+ }
611
+
612
+ /**
613
+ * @deprecated
614
+ */
615
+ export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
616
+ }
617
+
618
+ export interface GetAllRideSeriesForDriver {
619
+ accountId?: string;
620
+ descending?: boolean;
621
+ maxSize?: number;
622
+ timeRange?: InstantRange;
445
623
  }
446
624
 
447
- export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
625
+ export interface GetAllRideSeriesInMarketplace {
626
+ accountId?: string;
627
+ maxSize?: number;
448
628
  }
449
629
 
450
630
  export interface GetDistrict {
@@ -467,9 +647,22 @@ export interface GetIsoStates {
467
647
  export interface GetMonopolyAccounts {
468
648
  }
469
649
 
650
+ /**
651
+ * @deprecated
652
+ */
653
+ export interface GetMyAcceptedRides {
654
+ accountId?: string;
655
+ maxSize?: number;
656
+ timeRange?: InstantRange;
657
+ }
658
+
470
659
  export interface GetMyAccounts {
660
+ filter?: AccountFilter;
471
661
  }
472
662
 
663
+ /**
664
+ * @deprecated
665
+ */
473
666
  export interface GetMyRideOffers {
474
667
  accountId?: string;
475
668
  maxSize?: number;
@@ -491,14 +684,35 @@ export interface GetMyUserProfile {
491
684
  export interface GetNutsStates {
492
685
  }
493
686
 
494
- export interface GetPotentialDrivers {
687
+ /**
688
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
689
+
690
+ */
691
+ export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
692
+ }
693
+
694
+ /**
695
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
696
+
697
+ */
698
+ export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
699
+ }
700
+
701
+ /**
702
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
703
+
704
+ */
705
+ export interface GetPotentialDriversAbstract {
495
706
  fromDistrict?: string;
496
707
  mobility?: Mobility;
497
- rideType?: RideType;
498
708
  toDistrict?: string;
709
+ vehicleType?: VehicleType;
499
710
  weightInKg?: number;
500
711
  }
501
712
 
713
+ /**
714
+ * @deprecated
715
+ */
502
716
  export interface GetPotentialRides {
503
717
  accountId?: string;
504
718
  maxSize?: number;
@@ -512,14 +726,45 @@ export interface GetRide {
512
726
  export interface GetRideCsv extends RideStatisticsQuery {
513
727
  }
514
728
 
515
- export interface GetRideData extends RideStatisticsQuery {
516
- rideOwner?: string;
729
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
730
+ accountId?: string;
731
+ }
732
+
733
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
734
+ accountId?: string;
517
735
  }
518
736
 
519
737
  export interface GetRideLog {
520
738
  rideId?: string;
521
739
  }
522
740
 
741
+ export interface GetRideSeries {
742
+ rideSeriesId?: string;
743
+ }
744
+
745
+ export interface GetRideSeriesForDriver {
746
+ accountId?: string;
747
+ maxSize?: number;
748
+ timeRange?: InstantRange;
749
+ }
750
+
751
+ export interface GetRidesForDriver {
752
+ accountId?: string;
753
+ maxSize?: number;
754
+ timeRange?: InstantRange;
755
+ }
756
+
757
+ export interface GetRidesInMarketplace {
758
+ accountId?: string;
759
+ maxSize?: number;
760
+ timeRange?: InstantRange;
761
+ }
762
+
763
+ export interface GetRidesInSeries {
764
+ filter?: RideFilter;
765
+ rideSeriesId?: string;
766
+ }
767
+
523
768
  export interface GetTeam {
524
769
  teamId?: string;
525
770
  }
@@ -546,6 +791,14 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
546
791
  teamPermission?: TeamPermission;
547
792
  }
548
793
 
794
+ export interface IGetPotentialDrivers {
795
+ fromDistrict?: string;
796
+ mobility?: Mobility;
797
+ toDistrict?: string;
798
+ vehicleType?: VehicleType;
799
+ weightInKg?: number;
800
+ }
801
+
549
802
  export interface ImpersonateUser {
550
803
  userId?: string;
551
804
  }
@@ -586,6 +839,16 @@ export interface IsoState {
586
839
  nutsCode?: string;
587
840
  }
588
841
 
842
+ export interface Metric {
843
+ clientId?: string;
844
+ clientSegment?: number[];
845
+ maxSize?: number;
846
+ maxTimeout?: string;
847
+ tokenId?: string;
848
+ type?: string;
849
+ updates?: string[];
850
+ }
851
+
589
852
  export interface NutsDistrict {
590
853
  code?: string;
591
854
  name?: string;
@@ -608,6 +871,9 @@ export interface OffsetTimeRange {
608
871
  start?: Date;
609
872
  }
610
873
 
874
+ export interface OptimizerMessage {
875
+ }
876
+
611
877
  export interface Person {
612
878
  address?: AddressInfo;
613
879
  birthDay?: string;
@@ -632,6 +898,24 @@ export interface PersonDimensions {
632
898
  export interface PhoneNumber {
633
899
  }
634
900
 
901
+ export interface PlanRide extends RideDriverModifyCommand {
902
+ plannedStartTime?: string;
903
+ }
904
+
905
+ export interface ReadUpdates {
906
+ clientId?: string;
907
+ maxSize?: number;
908
+ maxTimeout?: number;
909
+ tokenId?: string;
910
+ updateTypes?: TrackingUpdateType[];
911
+ }
912
+
913
+ export interface ReadUpdatesResult {
914
+ clientSegment?: number[];
915
+ lastIndex?: number;
916
+ updates?: any[];
917
+ }
918
+
635
919
  export interface Region {
636
920
  nutsCode?: string;
637
921
  }
@@ -640,16 +924,11 @@ export interface RegisterAuthenticationToken extends UserUpdate {
640
924
  hashedToken?: string;
641
925
  }
642
926
 
643
- export interface RegisterDifferentEta extends FleetModifyCommand {
644
- destinationEta?: string;
645
- originEta?: string;
646
- }
647
-
648
- export interface RegisterDriveStatus extends FleetModifyCommand {
927
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
649
928
  driveStatus?: DriveStatus;
650
929
  }
651
930
 
652
- export interface RegisterDriverSynced extends FleetModifyCommand {
931
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
653
932
  }
654
933
 
655
934
  export interface RegisterEinsatz {
@@ -676,6 +955,13 @@ export interface ReportIssue {
676
955
  issue?: string;
677
956
  }
678
957
 
958
+ /**
959
+ * Can only report delays when ride has started and has not arrived at destination.
960
+ */
961
+ export interface ReportRideDelay extends RideDriverModifyCommand {
962
+ minutes?: number;
963
+ }
964
+
679
965
  export interface RequestDrivePermission extends AccountUpdate {
680
966
  drivePermissionId?: string;
681
967
  info?: DrivePermissionInfoRequest;
@@ -690,6 +976,34 @@ export interface RequestUserReset {
690
976
  email?: string;
691
977
  }
692
978
 
979
+ /**
980
+ * Resets the lastIndex position of your token.
981
+ */
982
+ export interface ResetPosition {
983
+ index?: number;
984
+ timestamp?: string;
985
+ tokenId?: string;
986
+ }
987
+
988
+ export interface ReturnRide extends RideDriverModifyCommand {
989
+ }
990
+
991
+ export interface ReturnRideSeries extends RideDriverSeriesCommand {
992
+ }
993
+
994
+ export interface Review {
995
+ comment?: string;
996
+ stars?: number;
997
+ }
998
+
999
+ export interface ReviewRideAsBooker extends RideBookerCommand {
1000
+ review?: Review;
1001
+ }
1002
+
1003
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
1004
+ review?: Review;
1005
+ }
1006
+
693
1007
  export interface RevokeAccountPermission extends AccountPermissionCommand {
694
1008
  }
695
1009
 
@@ -697,6 +1011,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
697
1011
  drivePermissionId?: string;
698
1012
  }
699
1013
 
1014
+ export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
1015
+ }
1016
+
700
1017
  export interface RevokeSubscription extends AccountUpdate {
701
1018
  subscriptionId?: string;
702
1019
  }
@@ -706,14 +1023,22 @@ export interface RevokeToken extends TokenUpdate {
706
1023
 
707
1024
  export interface Ride {
708
1025
  /**
709
- * Derived from driveOwner != null
1026
+ * Derived from driver != null
710
1027
  */
711
1028
  accepted?: boolean;
1029
+ actualEndTime?: string;
1030
+ actualStartTime?: string;
1031
+ /**
1032
+ * Derived from driveStatus != null
1033
+ */
1034
+ arrived?: boolean;
712
1035
  /**
713
1036
  * Derived from bookedTime != null
714
1037
  */
715
1038
  booked?: boolean;
716
1039
  bookedTime?: string;
1040
+ booker?: AccountOrTeamRef;
1041
+ bookerReview?: Review;
717
1042
  bookingStatus?: BookingStatus;
718
1043
  cancelReason?: string;
719
1044
  cancelled?: boolean;
@@ -722,37 +1047,72 @@ export interface Ride {
722
1047
  */
723
1048
  completed?: boolean;
724
1049
  /**
725
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
1050
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
726
1051
  */
727
- destinationEta?: string;
1052
+ desiredEndTime?: string;
728
1053
  /**
729
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1054
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
730
1055
  */
731
- destinationPta?: string;
732
- driveOwner?: AccountOrTeamRef;
1056
+ desiredStartTime?: string;
733
1057
  driveStatus?: DriveStatus;
1058
+ driver?: AccountOrTeamRef;
1059
+ driverReview?: Review;
734
1060
  driverSyncStatus?: SyncStatus;
1061
+ endTimeDelay?: number;
1062
+ /**
1063
+ * Expected Time of Arrival at the Destination/Drop-off location.
1064
+ */
1065
+ expectedEndTime?: string;
1066
+ /**
1067
+ * Expected Time of Arrival at the Origin/Pick-up location.
1068
+ */
1069
+ expectedStartTime?: string;
735
1070
  info?: RideInfo;
736
1071
  /**
737
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
1072
+ * Derived from plannedStartTime != null
738
1073
  */
739
- originEta?: string;
1074
+ planned?: boolean;
740
1075
  /**
741
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1076
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
742
1077
  */
743
- originPta?: string;
1078
+ plannedEndTime?: string;
1079
+ plannedStartTime?: string;
744
1080
  rideId?: string;
745
- rideOwner?: AccountOrTeamRef;
1081
+ /**
1082
+ * The time until which rides can be found. It's the planned time or else the desired time.
1083
+ */
1084
+ searchEndTime?: string;
1085
+ /**
1086
+ * The time from which rides can be found. It's the planned time or else the desired time.
1087
+ */
1088
+ searchStartTime?: string;
1089
+ seriesInfo?: SeriesInfo;
1090
+ startTimeDelay?: number;
746
1091
  /**
747
1092
  * Derived from driveStatus != null
748
1093
  */
749
1094
  started?: boolean;
750
1095
  }
751
1096
 
1097
+ export interface RideBookerCommand extends RideCommand {
1098
+ }
1099
+
1100
+ export interface RideBookerSeriesCommand extends RideSeriesCommand {
1101
+ }
1102
+
752
1103
  export interface RideCommand {
753
1104
  rideId?: string;
754
1105
  }
755
1106
 
1107
+ export interface RideDriverCommand extends RideCommand {
1108
+ }
1109
+
1110
+ export interface RideDriverModifyCommand extends RideDriverCommand {
1111
+ }
1112
+
1113
+ export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
1114
+ }
1115
+
756
1116
  /**
757
1117
  * All durations in seconds
758
1118
  */
@@ -765,39 +1125,39 @@ export interface RideDuration {
765
1125
 
766
1126
  export interface RideFilter {
767
1127
  bookingStatuses?: BookingStatus[];
768
- directions?: Direction[];
769
1128
  driveStatuses?: DriveStatus[];
770
1129
  driverAccountNames?: string[];
771
1130
  driverTeamNames?: string[];
772
1131
  hasInfection?: boolean;
773
1132
  heavyWeight?: boolean;
774
1133
  mobilities?: Mobility[];
1134
+ purposes?: RidePurpose[];
775
1135
  region?: Region;
776
1136
  requiresMonitoring?: boolean;
777
1137
  requiresOxygen?: boolean;
778
1138
  requiresSuctionAspirator?: boolean;
779
- rideType?: RideType;
780
1139
  riderAccountNames?: string[];
781
1140
  riderTeamNames?: string[];
782
1141
  timeRange?: InstantRange;
1142
+ vehicleType?: VehicleType;
783
1143
  }
784
1144
 
785
1145
  export interface RideFilterCount {
786
1146
  bookingStatuses?: { [P in BookingStatus]?: number };
787
- directions?: { [P in Direction]?: number };
788
1147
  driveStatuses?: { [P in DriveStatus]?: number };
789
1148
  driverAccountNames?: { [index: string]: number };
790
1149
  driverTeamNames?: { [index: string]: number };
791
1150
  hasInfection?: number;
792
1151
  heavyWeight?: number;
793
1152
  mobilities?: { [P in Mobility]?: number };
1153
+ purposes?: { [P in RidePurpose]?: number };
794
1154
  requiresMonitoring?: number;
795
1155
  requiresOxygen?: number;
796
1156
  requiresSuctionAspirator?: number;
797
- rideTypes?: { [P in RideType]?: number };
798
1157
  riderAccountNames?: { [index: string]: number };
799
1158
  riderTeamNames?: { [index: string]: number };
800
1159
  total?: number;
1160
+ vehicleTypes?: { [P in VehicleType]?: number };
801
1161
  }
802
1162
 
803
1163
  export interface RideIdResult {
@@ -813,7 +1173,6 @@ export interface RideInfo {
813
1173
  attendantsPresent?: number;
814
1174
  comment?: string;
815
1175
  dimensions?: PersonDimensions;
816
- direction?: Direction;
817
1176
  distanceInMeters?: number;
818
1177
  from?: AddressInfo;
819
1178
  /**
@@ -824,11 +1183,24 @@ export interface RideInfo {
824
1183
  patient?: Person;
825
1184
  plannedDuration?: RideDuration;
826
1185
  preferredDriver?: string;
827
- rideType?: RideType;
1186
+ purpose?: RidePurpose;
828
1187
  to?: AddressInfo;
1188
+ vehicleType?: VehicleType;
829
1189
  weightInKg?: number;
830
1190
  }
831
1191
 
1192
+ export interface RideInfoFilter {
1193
+ hasInfection?: boolean;
1194
+ heavyWeight?: boolean;
1195
+ mobilities?: Mobility[];
1196
+ purposes?: RidePurpose[];
1197
+ region?: Region;
1198
+ requiresMonitoring?: boolean;
1199
+ requiresOxygen?: boolean;
1200
+ requiresSuctionAspirator?: boolean;
1201
+ vehicleType?: VehicleType;
1202
+ }
1203
+
832
1204
  export interface RideLog {
833
1205
  actingFor?: AccountOrTeamRef;
834
1206
  allowedViewers?: AccountOrTeamRef[];
@@ -849,15 +1221,69 @@ export interface RideOfferInfo {
849
1221
  appointment?: Appointment;
850
1222
  }
851
1223
 
852
- export interface RidePlannerCommand extends RideCommand {
1224
+ export interface RideOperatorCommand extends RideCommand {
1225
+ }
1226
+
1227
+ export interface RideSeries {
1228
+ accepted?: boolean;
1229
+ booked?: boolean;
1230
+ booker?: AccountOrTeamRef;
1231
+ cancelled?: boolean;
1232
+ confirmed?: boolean;
1233
+ driver?: AccountOrTeamRef;
1234
+ endTime?: string;
1235
+ info?: GenericRideInfo;
1236
+ rideSeriesId?: string;
1237
+ rides?: SingleRide[];
1238
+ startTime?: string;
1239
+ status?: RideSeriesStatus;
1240
+ }
1241
+
1242
+ export interface RideSeriesCommand {
1243
+ rideSeriesId?: string;
1244
+ }
1245
+
1246
+ export interface RideSeriesIdResult {
1247
+ rideSeriesId?: string;
1248
+ }
1249
+
1250
+ export interface RideSeriesPostConfirmCommand {
1251
+ rideSeriesId?: string;
1252
+ ridesToModify?: Ride[];
1253
+ }
1254
+
1255
+ export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
1256
+ }
1257
+
1258
+ export interface RideSeriesUpdate {
1259
+ after?: RideSeries;
1260
+ before?: RideSeries;
1261
+ entityId?: string;
1262
+ eventType?: string;
1263
+ index?: number;
1264
+ timestamp?: string;
1265
+ type: "rideseries";
853
1266
  }
854
1267
 
855
1268
  export interface RideStatisticsQuery {
856
1269
  dateRange?: DateRange;
1270
+ zoneId?: string;
857
1271
  }
858
1272
 
859
- export interface RideTypeSpecificFilter {
860
- type: "ambulance" | "taxi";
1273
+ export interface RideSystemCommand extends RideCommand {
1274
+ }
1275
+
1276
+ export interface RideUpcaster {
1277
+ }
1278
+
1279
+ export interface RideUpdate {
1280
+ after?: Ride;
1281
+ before?: Ride;
1282
+ entityId?: string;
1283
+ eventType?: string;
1284
+ index?: number;
1285
+ timestamp?: string;
1286
+ type: "ride";
861
1287
  }
862
1288
 
863
1289
  export interface Role<T> {
@@ -867,8 +1293,12 @@ export interface Role<T> {
867
1293
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
868
1294
  */
869
1295
  export interface SaveRide extends CreateRideCommand {
1296
+ booker?: AccountOrTeamRef;
870
1297
  info?: RideInfo;
871
- owner?: AccountOrTeamRef;
1298
+ }
1299
+
1300
+ export interface SecondaryTokenPermissionCommand extends TokenUpdate {
1301
+ accountId?: string;
872
1302
  }
873
1303
 
874
1304
  export interface SendConfirmationEmail {
@@ -882,6 +1312,7 @@ export interface SendEmail {
882
1312
  export interface SendFreshdeskNewTicket {
883
1313
  email?: string;
884
1314
  message?: string;
1315
+ subject?: string;
885
1316
  }
886
1317
 
887
1318
  export interface SendInvitationEmail {
@@ -894,6 +1325,26 @@ export interface SendSlack {
894
1325
  message?: string;
895
1326
  }
896
1327
 
1328
+ /**
1329
+ * Information about a ride that is part of series.
1330
+ */
1331
+ export interface SeriesInfo {
1332
+ returnTrip?: boolean;
1333
+ rideSeriesId?: string;
1334
+ }
1335
+
1336
+ export interface SetOperateAccounts extends AccountUpdate {
1337
+ operateAccounts?: string[];
1338
+ }
1339
+
1340
+ export interface SetOperator extends AccountUpdate {
1341
+ operator?: string;
1342
+ }
1343
+
1344
+ export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
1345
+ accountPermission?: AccountPermission;
1346
+ }
1347
+
897
1348
  export interface SetSettings extends AccountUpdate {
898
1349
  settings?: any;
899
1350
  }
@@ -921,6 +1372,19 @@ export interface SignUpUser {
921
1372
  userId?: string;
922
1373
  }
923
1374
 
1375
+ /**
1376
+ * Individual ride timing within a series
1377
+ */
1378
+ export interface SingleRide {
1379
+ desiredStartTime?: string;
1380
+ returnTrip?: boolean;
1381
+ }
1382
+
1383
+ export interface SingleRideUpdate {
1384
+ desiredStartTime?: string;
1385
+ rideId?: string;
1386
+ }
1387
+
924
1388
  export interface StopImpersonatingUser {
925
1389
  }
926
1390
 
@@ -934,7 +1398,7 @@ export interface SubscriptionInfo extends TimedPermission {
934
1398
  service?: Service;
935
1399
  }
936
1400
 
937
- export interface TaxiFilter extends RideTypeSpecificFilter {
1401
+ export interface TaxiFilter extends DrivePermissionFilter {
938
1402
  allowedMobilities?: Mobility[];
939
1403
  type: "taxi";
940
1404
  }
@@ -970,10 +1434,11 @@ export interface TimedPermission {
970
1434
  }
971
1435
 
972
1436
  export interface Token {
973
- accountPermission?: AccountPermission;
1437
+ accountPermissions?: AccountPermission[];
974
1438
  createdBy?: string;
975
1439
  info?: TokenInfo;
976
1440
  lastUpdatedBy?: string;
1441
+ owner?: string;
977
1442
  revoked?: boolean;
978
1443
  tokenId?: string;
979
1444
  }
@@ -1001,9 +1466,24 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1001
1466
  accountPermission?: AccountPermission;
1002
1467
  }
1003
1468
 
1004
- export interface UpdateRideBooking extends RidePlannerCommand {
1469
+ export interface UpdatePosition {
1470
+ clientSegment?: number[];
1471
+ lastIndex?: number;
1472
+ tokenId?: string;
1473
+ }
1474
+
1475
+ export interface UpdateRide extends RideBookerCommand {
1476
+ booker?: AccountOrTeamRef;
1005
1477
  info?: RideInfo;
1006
- owner?: AccountOrTeamRef;
1478
+ }
1479
+
1480
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1481
+ plannedStartTime?: string;
1482
+ }
1483
+
1484
+ export interface UpdateRideSeries extends RideBookerSeriesCommand {
1485
+ info?: GenericRideInfo;
1486
+ rides?: SingleRide[];
1007
1487
  }
1008
1488
 
1009
1489
  export interface UpdateTeam extends TeamUpdate {
@@ -1019,6 +1499,9 @@ export interface UpdateUserInfo extends UserEdit {
1019
1499
  info?: UserInfo;
1020
1500
  }
1021
1501
 
1502
+ export interface UserAndTokenUpcaster {
1503
+ }
1504
+
1022
1505
  export interface UserCommand {
1023
1506
  userId?: string;
1024
1507
  }
@@ -1030,7 +1513,7 @@ export interface UserInfo {
1030
1513
  firstName?: string;
1031
1514
  language?: string;
1032
1515
  lastName?: string;
1033
- telephoneNumber?: string;
1516
+ telephoneNumber?: PhoneNumber;
1034
1517
  }
1035
1518
 
1036
1519
  export interface UserOrTokenId {
@@ -1059,13 +1542,13 @@ export interface ZonedTimeRange {
1059
1542
  start?: Date;
1060
1543
  }
1061
1544
 
1062
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1545
+ export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
1063
1546
 
1064
1547
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1065
1548
 
1066
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1549
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1067
1550
 
1068
- export type Direction = "admission" | "relocation" | "discharge";
1551
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1069
1552
 
1070
1553
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1071
1554
 
@@ -1075,20 +1558,26 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
1075
1558
 
1076
1559
  export type IntegrationType = "dispolive" | "celios";
1077
1560
 
1078
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1561
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1562
+
1563
+ export type OrganisationType = "medical" | "fleet" | "operator";
1079
1564
 
1080
- export type RideType = "taxi" | "ambulance";
1565
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1081
1566
 
1082
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1567
+ export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
1083
1568
 
1084
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1569
+ export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration";
1085
1570
 
1086
1571
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1087
1572
 
1088
- export type StandaloneService = "rideplanning" | "driveplanning";
1573
+ export type StandaloneService = "pro_medical" | "pro_fleet" | "pro_operator";
1089
1574
 
1090
1575
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1091
1576
 
1092
- export type TeamRole = "driveplanner" | "rideplanner";
1577
+ export type TeamRole = "dispatcher" | "ridebooker";
1578
+
1579
+ export type TrackingUpdateType = "ride" | "rideseries";
1093
1580
 
1094
1581
  export type UserRole = "superadmin";
1582
+
1583
+ 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.691-test-server",
3
+ "version": "0.1.691",
4
4
  "types": "common.d.ts"
5
5
  }
File without changes