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

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
+ operators?: 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,9 +78,16 @@ 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
 
87
+ export interface AddOperations extends AccountUpdate {
88
+ operateAccount?: string;
89
+ }
90
+
65
91
  /**
66
92
  * Address info of a google-validated address, including geolocation and district code
67
93
  */
@@ -97,13 +123,13 @@ export interface AdminSetUserPassword {
97
123
  userId?: string;
98
124
  }
99
125
 
100
- export interface AmbulanceFilter extends RideTypeSpecificFilter {
126
+ export interface AmbulanceFilter extends DrivePermissionFilter {
101
127
  heavyWeightAllowed?: boolean;
102
128
  type: "ambulance";
103
129
  }
104
130
 
105
131
  /**
106
- * Filled if (and only if) rideType == ambulance
132
+ * Filled if (and only if) vehicleType == ambulance
107
133
  */
108
134
  export interface AmbulanceInfo {
109
135
  /**
@@ -124,13 +150,26 @@ export interface AmbulanceInfo {
124
150
  requiresSuctionAspirator?: boolean;
125
151
  }
126
152
 
153
+ /**
154
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
155
+
156
+ */
157
+ export interface AnonymizedGenericRideInfo extends GenericRideInfo {
158
+ }
159
+
160
+ /**
161
+ * Information about the ride, from the creator of the ride
162
+ */
163
+ export interface AnonymizedRideInfo extends RideInfo {
164
+ }
165
+
127
166
  export interface Appointment {
128
167
  pickup?: boolean;
129
168
  time?: string;
130
169
  }
131
170
 
132
- export interface AssignDriver extends RideCommand {
133
- driveOwner?: AccountOrTeamRef;
171
+ export interface AssignDriver extends RideOperatorCommand {
172
+ driver?: AccountOrTeamRef;
134
173
  }
135
174
 
136
175
  export interface Attachment {
@@ -154,18 +193,38 @@ export interface AuthenticationResponse {
154
193
  export interface AuthenticationService {
155
194
  }
156
195
 
196
+ export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
197
+ info?: GenericRideInfo;
198
+ updater?: AccountOrTeamRef;
199
+ }
200
+
201
+ export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
202
+ rides?: SingleRideUpdate[];
203
+ updater?: AccountOrTeamRef;
204
+ }
205
+
157
206
  export interface BookRide extends CreateRideCommand {
207
+ booker?: AccountOrTeamRef;
158
208
  info?: RideInfo;
159
- owner?: AccountOrTeamRef;
160
209
  }
161
210
 
162
- export interface CancelDrive extends FleetModifyCommand {
211
+ export interface BookRideSeries extends RideBookerSeriesCommand {
212
+ booker?: AccountOrTeamRef;
213
+ info?: GenericRideInfo;
214
+ rides?: SingleRide[];
163
215
  }
164
216
 
165
- export interface CancelRide extends RidePlannerCommand {
217
+ export interface CancelRide extends RideBookerCommand {
166
218
  reason?: string;
167
219
  }
168
220
 
221
+ export interface CancelRideSeries extends RideBookerSeriesCommand {
222
+ }
223
+
224
+ export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
225
+ updater?: AccountOrTeamRef;
226
+ }
227
+
169
228
  export interface CeliosSettings {
170
229
  certificate?: string;
171
230
  host?: string;
@@ -217,16 +276,26 @@ export interface CreateAccount extends AccountCommand {
217
276
  requestService?: StandaloneService;
218
277
  }
219
278
 
220
- export interface CreateOptimizationPlan {
279
+ export interface CreateOptimizationPlan extends OptimizerMessage {
221
280
  accountOrTeam?: AccountOrTeamRef;
222
281
  timeRange?: InstantRange;
223
282
  }
224
283
 
225
- export interface CreateRideCommand extends RidePlannerCommand {
226
- owner?: AccountOrTeamId;
284
+ export interface CreateRideCommand extends RideBookerCommand {
285
+ booker?: AccountOrTeamId;
286
+ }
287
+
288
+ export interface CreateRideFromSeries extends RideDriverCommand {
289
+ booker?: AccountOrTeamRef;
290
+ driver?: AccountOrTeamRef;
291
+ info?: RideInfo;
292
+ seriesInfo?: SeriesInfo;
293
+ }
294
+
295
+ export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
227
296
  }
228
297
 
229
- export interface CreateSqueezeInPlan {
298
+ export interface CreateSqueezeInPlan extends OptimizerMessage {
230
299
  accountOrTeam?: AccountOrTeamRef;
231
300
  }
232
301
 
@@ -259,6 +328,11 @@ export interface DateRange {
259
328
  export interface DeleteUser extends UserEdit {
260
329
  }
261
330
 
331
+ export interface DisconnectClient {
332
+ clientId?: string;
333
+ tokenId?: string;
334
+ }
335
+
262
336
  export interface DispoliveSettings {
263
337
  key?: string;
264
338
  type: "dispolive";
@@ -291,14 +365,18 @@ export interface DrivePermission {
291
365
  revoked?: boolean;
292
366
  }
293
367
 
368
+ export interface DrivePermissionFilter {
369
+ type: "ambulance" | "taxi";
370
+ }
371
+
294
372
  export interface DrivePermissionInfo {
295
- filter?: RideTypeSpecificFilterUnion;
373
+ filter?: DrivePermissionFilterUnion;
296
374
  monopoly?: boolean;
297
375
  regions?: Region[];
298
376
  }
299
377
 
300
378
  export interface DrivePermissionInfoRequest {
301
- filter?: RideTypeSpecificFilterUnion;
379
+ filter?: DrivePermissionFilterUnion;
302
380
  regions?: Region[];
303
381
  }
304
382
 
@@ -348,10 +426,32 @@ export interface FetchRouteResult {
348
426
  duration?: number;
349
427
  }
350
428
 
429
+ /**
430
+ * @deprecated
431
+ */
351
432
  export interface FindAccount {
352
433
  term?: string;
353
434
  }
354
435
 
436
+ export interface FindAccounts {
437
+ filter?: AccountFilter;
438
+ term?: string;
439
+ }
440
+
441
+ /**
442
+ * @deprecated
443
+ */
444
+ export interface FindMyAcceptedRides {
445
+ accountId?: string;
446
+ descending?: boolean;
447
+ filter?: RideFilter;
448
+ maxSize?: number;
449
+ term?: string;
450
+ }
451
+
452
+ /**
453
+ * @deprecated
454
+ */
355
455
  export interface FindMyRideOffers {
356
456
  accountId?: string;
357
457
  descending?: boolean;
@@ -360,6 +460,14 @@ export interface FindMyRideOffers {
360
460
  term?: string;
361
461
  }
362
462
 
463
+ export interface FindMyRideSeries {
464
+ accountId?: string;
465
+ descending?: boolean;
466
+ maxSize?: number;
467
+ term?: string;
468
+ timeRange?: InstantRange;
469
+ }
470
+
363
471
  export interface FindMyRides {
364
472
  accountId?: string;
365
473
  descending?: boolean;
@@ -370,7 +478,6 @@ export interface FindMyRides {
370
478
 
371
479
  export interface FindMyTokens {
372
480
  accountId?: string;
373
- teamId?: string;
374
481
  term?: string;
375
482
  }
376
483
 
@@ -380,6 +487,16 @@ export interface FindMyUsers {
380
487
  term?: string;
381
488
  }
382
489
 
490
+ export interface FindPotentialRideSeries {
491
+ accountId?: string;
492
+ descending?: boolean;
493
+ filter?: RideInfoFilter;
494
+ maxSize?: number;
495
+ }
496
+
497
+ /**
498
+ * @deprecated
499
+ */
383
500
  export interface FindPotentialRides {
384
501
  accountId?: string;
385
502
  descending?: boolean;
@@ -395,6 +512,22 @@ export interface FindRides {
395
512
  term?: string;
396
513
  }
397
514
 
515
+ export interface FindRidesForDriver {
516
+ accountId?: string;
517
+ descending?: boolean;
518
+ filter?: RideFilter;
519
+ maxSize?: number;
520
+ term?: string;
521
+ }
522
+
523
+ export interface FindRidesInMarketplace {
524
+ accountId?: string;
525
+ descending?: boolean;
526
+ filter?: RideFilter;
527
+ maxSize?: number;
528
+ term?: string;
529
+ }
530
+
398
531
  export interface FindRidesResult {
399
532
  count?: RideFilterCount;
400
533
  rides?: Ride[];
@@ -408,18 +541,42 @@ export interface FindUsers {
408
541
  term?: string;
409
542
  }
410
543
 
411
- export interface FleetCommand extends RideCommand {
412
- }
413
-
414
- export interface FleetModifyCommand extends FleetCommand {
415
- }
416
-
417
544
  export interface GenerateToken {
418
545
  accountPermission?: AccountPermission;
419
546
  info?: TokenInfo;
420
547
  tokenId?: string;
421
548
  }
422
549
 
550
+ export interface GenerateTokenResult {
551
+ entity?: Token;
552
+ jwt?: string;
553
+ }
554
+
555
+ /**
556
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
557
+
558
+ */
559
+ export interface GenericRideInfo {
560
+ ambulanceInfo?: AmbulanceInfo;
561
+ attendantsPresent?: number;
562
+ comment?: string;
563
+ dimensions?: PersonDimensions;
564
+ distanceInMeters?: number;
565
+ from?: AddressInfo;
566
+ /**
567
+ * Derived from weightInKg != null
568
+ */
569
+ heavyWeight?: boolean;
570
+ mobility?: Mobility;
571
+ patient?: Person;
572
+ plannedDuration?: RideDuration;
573
+ preferredDriver?: string;
574
+ purpose?: RidePurpose;
575
+ to?: AddressInfo;
576
+ vehicleType?: VehicleType;
577
+ weightInKg?: number;
578
+ }
579
+
423
580
  export interface GeoJson {
424
581
  features?: Feature[];
425
582
  }
@@ -450,10 +607,28 @@ export interface GetAccount {
450
607
  accountId?: string;
451
608
  }
452
609
 
453
- export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
610
+ /**
611
+ * @deprecated
612
+ */
613
+ export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
454
614
  }
455
615
 
456
- export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
616
+ /**
617
+ * @deprecated
618
+ */
619
+ export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
620
+ }
621
+
622
+ export interface GetAllRideSeriesForDriver {
623
+ accountId?: string;
624
+ descending?: boolean;
625
+ maxSize?: number;
626
+ timeRange?: InstantRange;
627
+ }
628
+
629
+ export interface GetAllRideSeriesInMarketplace {
630
+ accountId?: string;
631
+ maxSize?: number;
457
632
  }
458
633
 
459
634
  export interface GetDistrict {
@@ -476,9 +651,22 @@ export interface GetIsoStates {
476
651
  export interface GetMonopolyAccounts {
477
652
  }
478
653
 
654
+ /**
655
+ * @deprecated
656
+ */
657
+ export interface GetMyAcceptedRides {
658
+ accountId?: string;
659
+ maxSize?: number;
660
+ timeRange?: InstantRange;
661
+ }
662
+
479
663
  export interface GetMyAccounts {
664
+ filter?: AccountFilter;
480
665
  }
481
666
 
667
+ /**
668
+ * @deprecated
669
+ */
482
670
  export interface GetMyRideOffers {
483
671
  accountId?: string;
484
672
  maxSize?: number;
@@ -500,14 +688,35 @@ export interface GetMyUserProfile {
500
688
  export interface GetNutsStates {
501
689
  }
502
690
 
503
- export interface GetPotentialDrivers {
691
+ /**
692
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
693
+
694
+ */
695
+ export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
696
+ }
697
+
698
+ /**
699
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
700
+
701
+ */
702
+ export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
703
+ }
704
+
705
+ /**
706
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
707
+
708
+ */
709
+ export interface GetPotentialDriversAbstract {
504
710
  fromDistrict?: string;
505
711
  mobility?: Mobility;
506
- rideType?: RideType;
507
712
  toDistrict?: string;
713
+ vehicleType?: VehicleType;
508
714
  weightInKg?: number;
509
715
  }
510
716
 
717
+ /**
718
+ * @deprecated
719
+ */
511
720
  export interface GetPotentialRides {
512
721
  accountId?: string;
513
722
  maxSize?: number;
@@ -521,14 +730,45 @@ export interface GetRide {
521
730
  export interface GetRideCsv extends RideStatisticsQuery {
522
731
  }
523
732
 
524
- export interface GetRideData extends RideStatisticsQuery {
525
- rideOwner?: string;
733
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
734
+ accountId?: string;
735
+ }
736
+
737
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
738
+ accountId?: string;
526
739
  }
527
740
 
528
741
  export interface GetRideLog {
529
742
  rideId?: string;
530
743
  }
531
744
 
745
+ export interface GetRideSeries {
746
+ rideSeriesId?: string;
747
+ }
748
+
749
+ export interface GetRideSeriesForDriver {
750
+ accountId?: string;
751
+ maxSize?: number;
752
+ timeRange?: InstantRange;
753
+ }
754
+
755
+ export interface GetRidesForDriver {
756
+ accountId?: string;
757
+ maxSize?: number;
758
+ timeRange?: InstantRange;
759
+ }
760
+
761
+ export interface GetRidesInMarketplace {
762
+ accountId?: string;
763
+ maxSize?: number;
764
+ timeRange?: InstantRange;
765
+ }
766
+
767
+ export interface GetRidesInSeries {
768
+ filter?: RideFilter;
769
+ rideSeriesId?: string;
770
+ }
771
+
532
772
  export interface GetTeam {
533
773
  teamId?: string;
534
774
  }
@@ -555,6 +795,14 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
555
795
  teamPermission?: TeamPermission;
556
796
  }
557
797
 
798
+ export interface IGetPotentialDrivers {
799
+ fromDistrict?: string;
800
+ mobility?: Mobility;
801
+ toDistrict?: string;
802
+ vehicleType?: VehicleType;
803
+ weightInKg?: number;
804
+ }
805
+
558
806
  export interface ImpersonateUser {
559
807
  userId?: string;
560
808
  }
@@ -595,6 +843,16 @@ export interface IsoState {
595
843
  nutsCode?: string;
596
844
  }
597
845
 
846
+ export interface Metric {
847
+ clientId?: string;
848
+ clientSegment?: number[];
849
+ maxSize?: number;
850
+ maxTimeout?: string;
851
+ tokenId?: string;
852
+ type?: string;
853
+ updates?: string[];
854
+ }
855
+
598
856
  export interface NutsDistrict {
599
857
  code?: string;
600
858
  name?: string;
@@ -617,6 +875,9 @@ export interface OffsetTimeRange {
617
875
  start?: Date;
618
876
  }
619
877
 
878
+ export interface OptimizerMessage {
879
+ }
880
+
620
881
  export interface Person {
621
882
  address?: AddressInfo;
622
883
  birthDay?: string;
@@ -641,6 +902,24 @@ export interface PersonDimensions {
641
902
  export interface PhoneNumber {
642
903
  }
643
904
 
905
+ export interface PlanRide extends RideDriverModifyCommand {
906
+ plannedStartTime?: string;
907
+ }
908
+
909
+ export interface ReadUpdates {
910
+ clientId?: string;
911
+ maxSize?: number;
912
+ maxTimeout?: number;
913
+ tokenId?: string;
914
+ updateTypes?: TrackingUpdateType[];
915
+ }
916
+
917
+ export interface ReadUpdatesResult {
918
+ clientSegment?: number[];
919
+ lastIndex?: number;
920
+ updates?: any[];
921
+ }
922
+
644
923
  export interface Region {
645
924
  nutsCode?: string;
646
925
  }
@@ -649,16 +928,11 @@ export interface RegisterAuthenticationToken extends UserUpdate {
649
928
  hashedToken?: string;
650
929
  }
651
930
 
652
- export interface RegisterDifferentEta extends FleetModifyCommand {
653
- destinationEta?: string;
654
- originEta?: string;
655
- }
656
-
657
- export interface RegisterDriveStatus extends FleetModifyCommand {
931
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
658
932
  driveStatus?: DriveStatus;
659
933
  }
660
934
 
661
- export interface RegisterDriverSynced extends FleetModifyCommand {
935
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
662
936
  }
663
937
 
664
938
  export interface RegisterEinsatz {
@@ -669,6 +943,14 @@ export interface RegisterEinsatz {
669
943
  export interface RemoveAccount extends AccountUpdate {
670
944
  }
671
945
 
946
+ export interface RemoveOperations extends AccountUpdate {
947
+ operateAccount?: string;
948
+ }
949
+
950
+ export interface RemoveOperator extends AccountUpdate {
951
+ operator?: string;
952
+ }
953
+
672
954
  export interface RemoveSettings extends AccountUpdate {
673
955
  type?: IntegrationType;
674
956
  }
@@ -685,6 +967,13 @@ export interface ReportIssue {
685
967
  issue?: string;
686
968
  }
687
969
 
970
+ /**
971
+ * Can only report delays when ride has started and has not arrived at destination.
972
+ */
973
+ export interface ReportRideDelay extends RideDriverModifyCommand {
974
+ minutes?: number;
975
+ }
976
+
688
977
  export interface RequestDrivePermission extends AccountUpdate {
689
978
  drivePermissionId?: string;
690
979
  info?: DrivePermissionInfoRequest;
@@ -699,6 +988,34 @@ export interface RequestUserReset {
699
988
  email?: string;
700
989
  }
701
990
 
991
+ /**
992
+ * Resets the lastIndex position of your token.
993
+ */
994
+ export interface ResetPosition {
995
+ index?: number;
996
+ timestamp?: string;
997
+ tokenId?: string;
998
+ }
999
+
1000
+ export interface ReturnRide extends RideDriverModifyCommand {
1001
+ }
1002
+
1003
+ export interface ReturnRideSeries extends RideDriverSeriesCommand {
1004
+ }
1005
+
1006
+ export interface Review {
1007
+ comment?: string;
1008
+ stars?: number;
1009
+ }
1010
+
1011
+ export interface ReviewRideAsBooker extends RideBookerCommand {
1012
+ review?: Review;
1013
+ }
1014
+
1015
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
1016
+ review?: Review;
1017
+ }
1018
+
702
1019
  export interface RevokeAccountPermission extends AccountPermissionCommand {
703
1020
  }
704
1021
 
@@ -706,6 +1023,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
706
1023
  drivePermissionId?: string;
707
1024
  }
708
1025
 
1026
+ export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
1027
+ }
1028
+
709
1029
  export interface RevokeSubscription extends AccountUpdate {
710
1030
  subscriptionId?: string;
711
1031
  }
@@ -715,14 +1035,22 @@ export interface RevokeToken extends TokenUpdate {
715
1035
 
716
1036
  export interface Ride {
717
1037
  /**
718
- * Derived from driveOwner != null
1038
+ * Derived from driver != null
719
1039
  */
720
1040
  accepted?: boolean;
1041
+ actualEndTime?: string;
1042
+ actualStartTime?: string;
1043
+ /**
1044
+ * Derived from driveStatus != null
1045
+ */
1046
+ arrived?: boolean;
721
1047
  /**
722
1048
  * Derived from bookedTime != null
723
1049
  */
724
1050
  booked?: boolean;
725
1051
  bookedTime?: string;
1052
+ booker?: AccountOrTeamRef;
1053
+ bookerReview?: Review;
726
1054
  bookingStatus?: BookingStatus;
727
1055
  cancelReason?: string;
728
1056
  cancelled?: boolean;
@@ -731,37 +1059,72 @@ export interface Ride {
731
1059
  */
732
1060
  completed?: boolean;
733
1061
  /**
734
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
1062
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
735
1063
  */
736
- destinationEta?: string;
1064
+ desiredEndTime?: string;
737
1065
  /**
738
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1066
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
739
1067
  */
740
- destinationPta?: string;
741
- driveOwner?: AccountOrTeamRef;
1068
+ desiredStartTime?: string;
742
1069
  driveStatus?: DriveStatus;
1070
+ driver?: AccountOrTeamRef;
1071
+ driverReview?: Review;
743
1072
  driverSyncStatus?: SyncStatus;
1073
+ endTimeDelay?: number;
1074
+ /**
1075
+ * Expected Time of Arrival at the Destination/Drop-off location.
1076
+ */
1077
+ expectedEndTime?: string;
1078
+ /**
1079
+ * Expected Time of Arrival at the Origin/Pick-up location.
1080
+ */
1081
+ expectedStartTime?: string;
744
1082
  info?: RideInfo;
745
1083
  /**
746
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
1084
+ * Derived from plannedStartTime != null
747
1085
  */
748
- originEta?: string;
1086
+ planned?: boolean;
749
1087
  /**
750
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1088
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
751
1089
  */
752
- originPta?: string;
1090
+ plannedEndTime?: string;
1091
+ plannedStartTime?: string;
753
1092
  rideId?: string;
754
- rideOwner?: AccountOrTeamRef;
1093
+ /**
1094
+ * The time until which rides can be found. It's the planned time or else the desired time.
1095
+ */
1096
+ searchEndTime?: string;
1097
+ /**
1098
+ * The time from which rides can be found. It's the planned time or else the desired time.
1099
+ */
1100
+ searchStartTime?: string;
1101
+ seriesInfo?: SeriesInfo;
1102
+ startTimeDelay?: number;
755
1103
  /**
756
1104
  * Derived from driveStatus != null
757
1105
  */
758
1106
  started?: boolean;
759
1107
  }
760
1108
 
1109
+ export interface RideBookerCommand extends RideCommand {
1110
+ }
1111
+
1112
+ export interface RideBookerSeriesCommand extends RideSeriesCommand {
1113
+ }
1114
+
761
1115
  export interface RideCommand {
762
1116
  rideId?: string;
763
1117
  }
764
1118
 
1119
+ export interface RideDriverCommand extends RideCommand {
1120
+ }
1121
+
1122
+ export interface RideDriverModifyCommand extends RideDriverCommand {
1123
+ }
1124
+
1125
+ export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
1126
+ }
1127
+
765
1128
  /**
766
1129
  * All durations in seconds
767
1130
  */
@@ -774,39 +1137,39 @@ export interface RideDuration {
774
1137
 
775
1138
  export interface RideFilter {
776
1139
  bookingStatuses?: BookingStatus[];
777
- directions?: Direction[];
778
1140
  driveStatuses?: DriveStatus[];
779
1141
  driverAccountNames?: string[];
780
1142
  driverTeamNames?: string[];
781
1143
  hasInfection?: boolean;
782
1144
  heavyWeight?: boolean;
783
1145
  mobilities?: Mobility[];
1146
+ purposes?: RidePurpose[];
784
1147
  region?: Region;
785
1148
  requiresMonitoring?: boolean;
786
1149
  requiresOxygen?: boolean;
787
1150
  requiresSuctionAspirator?: boolean;
788
- rideType?: RideType;
789
1151
  riderAccountNames?: string[];
790
1152
  riderTeamNames?: string[];
791
1153
  timeRange?: InstantRange;
1154
+ vehicleType?: VehicleType;
792
1155
  }
793
1156
 
794
1157
  export interface RideFilterCount {
795
1158
  bookingStatuses?: { [P in BookingStatus]?: number };
796
- directions?: { [P in Direction]?: number };
797
1159
  driveStatuses?: { [P in DriveStatus]?: number };
798
1160
  driverAccountNames?: { [index: string]: number };
799
1161
  driverTeamNames?: { [index: string]: number };
800
1162
  hasInfection?: number;
801
1163
  heavyWeight?: number;
802
1164
  mobilities?: { [P in Mobility]?: number };
1165
+ purposes?: { [P in RidePurpose]?: number };
803
1166
  requiresMonitoring?: number;
804
1167
  requiresOxygen?: number;
805
1168
  requiresSuctionAspirator?: number;
806
- rideTypes?: { [P in RideType]?: number };
807
1169
  riderAccountNames?: { [index: string]: number };
808
1170
  riderTeamNames?: { [index: string]: number };
809
1171
  total?: number;
1172
+ vehicleTypes?: { [P in VehicleType]?: number };
810
1173
  }
811
1174
 
812
1175
  export interface RideIdResult {
@@ -822,7 +1185,6 @@ export interface RideInfo {
822
1185
  attendantsPresent?: number;
823
1186
  comment?: string;
824
1187
  dimensions?: PersonDimensions;
825
- direction?: Direction;
826
1188
  distanceInMeters?: number;
827
1189
  from?: AddressInfo;
828
1190
  /**
@@ -833,11 +1195,24 @@ export interface RideInfo {
833
1195
  patient?: Person;
834
1196
  plannedDuration?: RideDuration;
835
1197
  preferredDriver?: string;
836
- rideType?: RideType;
1198
+ purpose?: RidePurpose;
837
1199
  to?: AddressInfo;
1200
+ vehicleType?: VehicleType;
838
1201
  weightInKg?: number;
839
1202
  }
840
1203
 
1204
+ export interface RideInfoFilter {
1205
+ hasInfection?: boolean;
1206
+ heavyWeight?: boolean;
1207
+ mobilities?: Mobility[];
1208
+ purposes?: RidePurpose[];
1209
+ region?: Region;
1210
+ requiresMonitoring?: boolean;
1211
+ requiresOxygen?: boolean;
1212
+ requiresSuctionAspirator?: boolean;
1213
+ vehicleType?: VehicleType;
1214
+ }
1215
+
841
1216
  export interface RideLog {
842
1217
  actingFor?: AccountOrTeamRef;
843
1218
  allowedViewers?: AccountOrTeamRef[];
@@ -858,15 +1233,69 @@ export interface RideOfferInfo {
858
1233
  appointment?: Appointment;
859
1234
  }
860
1235
 
861
- export interface RidePlannerCommand extends RideCommand {
1236
+ export interface RideOperatorCommand extends RideCommand {
1237
+ }
1238
+
1239
+ export interface RideSeries {
1240
+ accepted?: boolean;
1241
+ booked?: boolean;
1242
+ booker?: AccountOrTeamRef;
1243
+ cancelled?: boolean;
1244
+ confirmed?: boolean;
1245
+ driver?: AccountOrTeamRef;
1246
+ endTime?: string;
1247
+ info?: GenericRideInfo;
1248
+ rideSeriesId?: string;
1249
+ rides?: SingleRide[];
1250
+ startTime?: string;
1251
+ status?: RideSeriesStatus;
1252
+ }
1253
+
1254
+ export interface RideSeriesCommand {
1255
+ rideSeriesId?: string;
1256
+ }
1257
+
1258
+ export interface RideSeriesIdResult {
1259
+ rideSeriesId?: string;
1260
+ }
1261
+
1262
+ export interface RideSeriesPostConfirmCommand {
1263
+ rideSeriesId?: string;
1264
+ ridesToModify?: Ride[];
1265
+ }
1266
+
1267
+ export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
1268
+ }
1269
+
1270
+ export interface RideSeriesUpdate {
1271
+ after?: RideSeries;
1272
+ before?: RideSeries;
1273
+ entityId?: string;
1274
+ eventType?: string;
1275
+ index?: number;
1276
+ timestamp?: string;
1277
+ type: "rideseries";
862
1278
  }
863
1279
 
864
1280
  export interface RideStatisticsQuery {
865
1281
  dateRange?: DateRange;
1282
+ zoneId?: string;
866
1283
  }
867
1284
 
868
- export interface RideTypeSpecificFilter {
869
- type: "ambulance" | "taxi";
1285
+ export interface RideSystemCommand extends RideCommand {
1286
+ }
1287
+
1288
+ export interface RideUpcaster {
1289
+ }
1290
+
1291
+ export interface RideUpdate {
1292
+ after?: Ride;
1293
+ before?: Ride;
1294
+ entityId?: string;
1295
+ eventType?: string;
1296
+ index?: number;
1297
+ timestamp?: string;
1298
+ type: "ride";
870
1299
  }
871
1300
 
872
1301
  export interface Role<T> {
@@ -876,8 +1305,12 @@ export interface Role<T> {
876
1305
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
877
1306
  */
878
1307
  export interface SaveRide extends CreateRideCommand {
1308
+ booker?: AccountOrTeamRef;
879
1309
  info?: RideInfo;
880
- owner?: AccountOrTeamRef;
1310
+ }
1311
+
1312
+ export interface SecondaryTokenPermissionCommand extends TokenUpdate {
1313
+ accountId?: string;
881
1314
  }
882
1315
 
883
1316
  export interface SendConfirmationEmail {
@@ -891,6 +1324,7 @@ export interface SendEmail {
891
1324
  export interface SendFreshdeskNewTicket {
892
1325
  email?: string;
893
1326
  message?: string;
1327
+ subject?: string;
894
1328
  }
895
1329
 
896
1330
  export interface SendInvitationEmail {
@@ -903,6 +1337,26 @@ export interface SendSlack {
903
1337
  message?: string;
904
1338
  }
905
1339
 
1340
+ /**
1341
+ * Information about a ride that is part of series.
1342
+ */
1343
+ export interface SeriesInfo {
1344
+ returnTrip?: boolean;
1345
+ rideSeriesId?: string;
1346
+ }
1347
+
1348
+ export interface SetOperations extends AccountUpdate {
1349
+ operateAccounts?: string[];
1350
+ }
1351
+
1352
+ export interface SetOperator extends AccountUpdate {
1353
+ operator?: string;
1354
+ }
1355
+
1356
+ export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
1357
+ accountPermission?: AccountPermission;
1358
+ }
1359
+
906
1360
  export interface SetSettings extends AccountUpdate {
907
1361
  settings?: any;
908
1362
  }
@@ -930,6 +1384,19 @@ export interface SignUpUser {
930
1384
  userId?: string;
931
1385
  }
932
1386
 
1387
+ /**
1388
+ * Individual ride timing within a series
1389
+ */
1390
+ export interface SingleRide {
1391
+ desiredStartTime?: string;
1392
+ returnTrip?: boolean;
1393
+ }
1394
+
1395
+ export interface SingleRideUpdate {
1396
+ desiredStartTime?: string;
1397
+ rideId?: string;
1398
+ }
1399
+
933
1400
  export interface StopImpersonatingUser {
934
1401
  }
935
1402
 
@@ -943,7 +1410,7 @@ export interface SubscriptionInfo extends TimedPermission {
943
1410
  service?: Service;
944
1411
  }
945
1412
 
946
- export interface TaxiFilter extends RideTypeSpecificFilter {
1413
+ export interface TaxiFilter extends DrivePermissionFilter {
947
1414
  allowedMobilities?: Mobility[];
948
1415
  type: "taxi";
949
1416
  }
@@ -979,10 +1446,11 @@ export interface TimedPermission {
979
1446
  }
980
1447
 
981
1448
  export interface Token {
982
- accountPermission?: AccountPermission;
1449
+ accountPermissions?: AccountPermission[];
983
1450
  createdBy?: string;
984
1451
  info?: TokenInfo;
985
1452
  lastUpdatedBy?: string;
1453
+ owner?: string;
986
1454
  revoked?: boolean;
987
1455
  tokenId?: string;
988
1456
  }
@@ -1010,9 +1478,24 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1010
1478
  accountPermission?: AccountPermission;
1011
1479
  }
1012
1480
 
1013
- export interface UpdateRideBooking extends RidePlannerCommand {
1481
+ export interface UpdatePosition {
1482
+ clientSegment?: number[];
1483
+ lastIndex?: number;
1484
+ tokenId?: string;
1485
+ }
1486
+
1487
+ export interface UpdateRide extends RideBookerCommand {
1488
+ booker?: AccountOrTeamRef;
1014
1489
  info?: RideInfo;
1015
- owner?: AccountOrTeamRef;
1490
+ }
1491
+
1492
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1493
+ plannedStartTime?: string;
1494
+ }
1495
+
1496
+ export interface UpdateRideSeries extends RideBookerSeriesCommand {
1497
+ info?: GenericRideInfo;
1498
+ rides?: SingleRide[];
1016
1499
  }
1017
1500
 
1018
1501
  export interface UpdateTeam extends TeamUpdate {
@@ -1028,6 +1511,9 @@ export interface UpdateUserInfo extends UserEdit {
1028
1511
  info?: UserInfo;
1029
1512
  }
1030
1513
 
1514
+ export interface UserAndTokenUpcaster {
1515
+ }
1516
+
1031
1517
  export interface UserCommand {
1032
1518
  userId?: string;
1033
1519
  }
@@ -1039,7 +1525,7 @@ export interface UserInfo {
1039
1525
  firstName?: string;
1040
1526
  language?: string;
1041
1527
  lastName?: string;
1042
- telephoneNumber?: string;
1528
+ telephoneNumber?: PhoneNumber;
1043
1529
  }
1044
1530
 
1045
1531
  export interface UserOrTokenId {
@@ -1068,13 +1554,13 @@ export interface ZonedTimeRange {
1068
1554
  start?: Date;
1069
1555
  }
1070
1556
 
1071
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1557
+ export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
1072
1558
 
1073
1559
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1074
1560
 
1075
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1561
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1076
1562
 
1077
- export type Direction = "admission" | "relocation" | "discharge";
1563
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1078
1564
 
1079
1565
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1080
1566
 
@@ -1084,20 +1570,26 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
1084
1570
 
1085
1571
  export type IntegrationType = "dispolive" | "celios";
1086
1572
 
1087
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1573
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1574
+
1575
+ export type OrganisationType = "medical" | "fleet" | "operator";
1088
1576
 
1089
- export type RideType = "taxi" | "ambulance";
1577
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1090
1578
 
1091
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1579
+ export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
1092
1580
 
1093
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1581
+ export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";
1094
1582
 
1095
1583
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1096
1584
 
1097
- export type StandaloneService = "rideplanning" | "driveplanning";
1585
+ export type StandaloneService = "pro_medical" | "pro_fleet" | "pro_operator";
1098
1586
 
1099
1587
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1100
1588
 
1101
- export type TeamRole = "driveplanner" | "rideplanner";
1589
+ export type TeamRole = "dispatcher" | "ridebooker";
1590
+
1591
+ export type TrackingUpdateType = "ride" | "rideseries";
1102
1592
 
1103
1593
  export type UserRole = "superadmin";
1594
+
1595
+ 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.731-test-server",
3
+ "version": "0.1.731",
4
4
  "types": "common.d.ts"
5
5
  }
File without changes