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

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,41 @@
1
1
 
2
- export interface AcceptDrive extends FleetCommand {
3
- driveOwner?: AccountOrTeamRef;
2
+ export interface AbstractFindMyRides {
3
+ accountId?: string;
4
+ descending?: boolean;
5
+ filter?: RideFilter;
6
+ maxSize?: number;
7
+ term?: string;
8
+ }
9
+
10
+ export interface AbstractFindRides {
11
+ descending?: boolean;
12
+ filter?: RideFilter;
13
+ maxSize?: number;
14
+ term?: string;
15
+ }
16
+
17
+ export interface AbstractFindRidesForDriver {
18
+ accountId?: string;
19
+ descending?: boolean;
20
+ filter?: RideFilter;
21
+ maxSize?: number;
22
+ term?: string;
23
+ }
24
+
25
+ export interface AbstractFindRidesInMarketplace {
26
+ accountId?: string;
27
+ descending?: boolean;
28
+ filter?: RideFilter;
29
+ maxSize?: number;
30
+ term?: string;
31
+ }
32
+
33
+ export interface AcceptRide extends RideDriverCommand {
34
+ driver?: AccountOrTeamRef;
35
+ }
36
+
37
+ export interface AcceptRideSeries extends SeriesDriverCommand {
38
+ driver?: AccountOrTeamRef;
4
39
  }
5
40
 
6
41
  export interface AcceptUserAgreement extends UserEdit {
@@ -9,6 +44,10 @@ export interface AcceptUserAgreement extends UserEdit {
9
44
 
10
45
  export interface Account {
11
46
  accountId?: string;
47
+ /**
48
+ * Derived from subscriptions
49
+ */
50
+ activeOrganisationTypes?: OrganisationType[];
12
51
  /**
13
52
  * Derived from subscriptions
14
53
  */
@@ -18,6 +57,12 @@ export interface Account {
18
57
  drivePermissions?: DrivePermission[];
19
58
  info?: AccountInfo;
20
59
  integrationSettings?: any[];
60
+ operateAccounts?: string[];
61
+ operators?: string[];
62
+ /**
63
+ * Derived from subscriptions. Includes organisation types that have not been confirmed yet by a superadmin or are active in past or future.
64
+ */
65
+ organisationTypes?: OrganisationType[];
21
66
  subscriptions?: Subscription[];
22
67
  teams?: Team[];
23
68
  unconfirmedCriticalInfo?: CriticalAccountInfo;
@@ -27,11 +72,16 @@ export interface AccountCommand {
27
72
  accountId?: string;
28
73
  }
29
74
 
75
+ export interface AccountFilter {
76
+ activeServices?: Service[];
77
+ }
78
+
30
79
  export interface AccountInfo {
31
80
  address?: AddressInfo;
32
81
  defaultLanguage?: string;
33
82
  notificationEmails?: string[];
34
83
  phoneNumber?: PhoneNumber;
84
+ zoneId?: string;
35
85
  }
36
86
 
37
87
  export interface AccountOrTeamId {
@@ -59,9 +109,16 @@ export interface AccountRef {
59
109
  name?: string;
60
110
  }
61
111
 
112
+ export interface AccountUpcaster {
113
+ }
114
+
62
115
  export interface AccountUpdate extends AccountCommand {
63
116
  }
64
117
 
118
+ export interface AddOperations extends AccountUpdate {
119
+ operateAccount?: string;
120
+ }
121
+
65
122
  /**
66
123
  * Address info of a google-validated address, including geolocation and district code
67
124
  */
@@ -97,13 +154,13 @@ export interface AdminSetUserPassword {
97
154
  userId?: string;
98
155
  }
99
156
 
100
- export interface AmbulanceFilter extends RideTypeSpecificFilter {
157
+ export interface AmbulanceFilter extends DrivePermissionFilter {
101
158
  heavyWeightAllowed?: boolean;
102
159
  type: "ambulance";
103
160
  }
104
161
 
105
162
  /**
106
- * Filled if (and only if) rideType == ambulance
163
+ * Filled if (and only if) vehicleType == ambulance
107
164
  */
108
165
  export interface AmbulanceInfo {
109
166
  /**
@@ -124,13 +181,29 @@ export interface AmbulanceInfo {
124
181
  requiresSuctionAspirator?: boolean;
125
182
  }
126
183
 
184
+ /**
185
+ * Information about the ride, from the creator of the ride
186
+ */
187
+ export interface AnonymizedRideInfo extends RideInfo {
188
+ }
189
+
190
+ /**
191
+ * Information about the ride, from the creator of the ride
192
+ */
193
+ export interface AnonymizedSeriesRideInfo extends SeriesRideInfo {
194
+ }
195
+
127
196
  export interface Appointment {
128
197
  pickup?: boolean;
129
198
  time?: string;
130
199
  }
131
200
 
132
- export interface AssignDriver extends RideCommand {
133
- driveOwner?: AccountOrTeamRef;
201
+ export interface AssignDriver extends RideOperatorCommand {
202
+ driver?: AccountOrTeamRef;
203
+ }
204
+
205
+ export interface AssignRideSeriesDriver extends SeriesOperatorCommand {
206
+ driver?: AccountOrTeamRef;
134
207
  }
135
208
 
136
209
  export interface Attachment {
@@ -156,13 +229,22 @@ export interface AuthenticationService {
156
229
 
157
230
  export interface BookRide extends CreateRideCommand {
158
231
  info?: RideInfo;
159
- owner?: AccountOrTeamRef;
160
232
  }
161
233
 
162
- export interface CancelDrive extends FleetModifyCommand {
234
+ export interface BookRideSeries extends CreateSeriesCommand {
235
+ rideSummaries?: RideSummary[];
236
+ }
237
+
238
+ export interface CancelRide extends RideBookerCommand {
239
+ reason?: string;
240
+ }
241
+
242
+ export interface CancelRideSeries extends SeriesCommandWithSeparateEvent {
243
+ reason?: string;
163
244
  }
164
245
 
165
- export interface CancelRide extends RidePlannerCommand {
246
+ export interface CancelRideSeriesEvent extends SeriesBookerCommand {
247
+ cancelRides?: string[];
166
248
  reason?: string;
167
249
  }
168
250
 
@@ -222,8 +304,13 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
222
304
  timeRange?: InstantRange;
223
305
  }
224
306
 
225
- export interface CreateRideCommand extends RidePlannerCommand {
226
- owner?: AccountOrTeamId;
307
+ export interface CreateRideCommand extends RideBookerCommand {
308
+ booker?: AccountOrTeamRef;
309
+ }
310
+
311
+ export interface CreateSeriesCommand extends SeriesBookerCommand {
312
+ booker?: AccountOrTeamRef;
313
+ info?: SeriesRideInfo;
227
314
  }
228
315
 
229
316
  export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -259,6 +346,11 @@ export interface DateRange {
259
346
  export interface DeleteUser extends UserEdit {
260
347
  }
261
348
 
349
+ export interface DisconnectClient {
350
+ clientId?: string;
351
+ tokenId?: string;
352
+ }
353
+
262
354
  export interface DispoliveSettings {
263
355
  key?: string;
264
356
  type: "dispolive";
@@ -291,14 +383,18 @@ export interface DrivePermission {
291
383
  revoked?: boolean;
292
384
  }
293
385
 
386
+ export interface DrivePermissionFilter {
387
+ type: "ambulance" | "taxi";
388
+ }
389
+
294
390
  export interface DrivePermissionInfo {
295
- filter?: RideTypeSpecificFilterUnion;
391
+ filter?: DrivePermissionFilterUnion;
296
392
  monopoly?: boolean;
297
393
  regions?: Region[];
298
394
  }
299
395
 
300
396
  export interface DrivePermissionInfoRequest {
301
- filter?: RideTypeSpecificFilterUnion;
397
+ filter?: DrivePermissionFilterUnion;
302
398
  regions?: Region[];
303
399
  }
304
400
 
@@ -348,29 +444,29 @@ export interface FetchRouteResult {
348
444
  duration?: number;
349
445
  }
350
446
 
447
+ /**
448
+ * @deprecated
449
+ */
351
450
  export interface FindAccount {
352
451
  term?: string;
353
452
  }
354
453
 
355
- export interface FindMyRideOffers {
356
- accountId?: string;
357
- descending?: boolean;
358
- filter?: RideFilter;
359
- maxSize?: number;
454
+ export interface FindAccounts {
455
+ filter?: AccountFilter;
360
456
  term?: string;
361
457
  }
362
458
 
363
- export interface FindMyRides {
364
- accountId?: string;
365
- descending?: boolean;
366
- filter?: RideFilter;
367
- maxSize?: number;
368
- term?: string;
459
+ export interface FindMyRides extends AbstractFindMyRides {
460
+ }
461
+
462
+ export interface FindMyRidesAndSeries extends AbstractFindMyRides {
463
+ }
464
+
465
+ export interface FindMySeries extends AbstractFindMyRides {
369
466
  }
370
467
 
371
468
  export interface FindMyTokens {
372
469
  accountId?: string;
373
- teamId?: string;
374
470
  term?: string;
375
471
  }
376
472
 
@@ -380,19 +476,27 @@ export interface FindMyUsers {
380
476
  term?: string;
381
477
  }
382
478
 
383
- export interface FindPotentialRides {
384
- accountId?: string;
385
- descending?: boolean;
386
- filter?: RideFilter;
387
- maxSize?: number;
388
- term?: string;
479
+ export interface FindRides extends AbstractFindRides {
389
480
  }
390
481
 
391
- export interface FindRides {
392
- descending?: boolean;
393
- filter?: RideFilter;
394
- maxSize?: number;
395
- term?: string;
482
+ export interface FindRidesAndSeries extends AbstractFindRides {
483
+ }
484
+
485
+ export interface FindRidesAndSeriesForDriver extends AbstractFindRidesForDriver {
486
+ }
487
+
488
+ export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMarketplace {
489
+ }
490
+
491
+ export interface FindRidesAndSeriesResult {
492
+ ridesAndSeries?: RideOrMinimizedSeries[];
493
+ ridesCount?: RideFilterCount;
494
+ }
495
+
496
+ export interface FindRidesForDriver extends AbstractFindRidesForDriver {
497
+ }
498
+
499
+ export interface FindRidesInMarketplace extends AbstractFindRidesInMarketplace {
396
500
  }
397
501
 
398
502
  export interface FindRidesResult {
@@ -400,18 +504,21 @@ export interface FindRidesResult {
400
504
  rides?: Ride[];
401
505
  }
402
506
 
403
- export interface FindTokens {
404
- term?: string;
507
+ export interface FindSeries extends AbstractFindRides {
405
508
  }
406
509
 
407
- export interface FindUsers {
408
- term?: string;
510
+ export interface FindSeriesForDriver extends AbstractFindRidesForDriver {
409
511
  }
410
512
 
411
- export interface FleetCommand extends RideCommand {
513
+ export interface FindSeriesInMarketplace extends AbstractFindRidesInMarketplace {
412
514
  }
413
515
 
414
- export interface FleetModifyCommand extends FleetCommand {
516
+ export interface FindTokens {
517
+ term?: string;
518
+ }
519
+
520
+ export interface FindUsers {
521
+ term?: string;
415
522
  }
416
523
 
417
524
  export interface GenerateToken {
@@ -420,6 +527,35 @@ export interface GenerateToken {
420
527
  tokenId?: string;
421
528
  }
422
529
 
530
+ export interface GenerateTokenResult {
531
+ entity?: Token;
532
+ jwt?: string;
533
+ }
534
+
535
+ /**
536
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
537
+
538
+ */
539
+ export interface GenericRideInfo {
540
+ ambulanceInfo?: AmbulanceInfo;
541
+ attendantsPresent?: number;
542
+ comment?: string;
543
+ dimensions?: PersonDimensions;
544
+ distanceInMeters?: number;
545
+ from?: AddressInfo;
546
+ /**
547
+ * Derived from weightInKg != null
548
+ */
549
+ heavyWeight?: boolean;
550
+ mobility?: Mobility;
551
+ patient?: Person;
552
+ plannedDuration?: RideDuration;
553
+ preferredDriver?: string;
554
+ to?: AddressInfo;
555
+ vehicleType?: VehicleType;
556
+ weightInKg?: number;
557
+ }
558
+
423
559
  export interface GeoJson {
424
560
  features?: Feature[];
425
561
  }
@@ -450,10 +586,16 @@ export interface GetAccount {
450
586
  accountId?: string;
451
587
  }
452
588
 
453
- export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
589
+ /**
590
+ * @deprecated
591
+ */
592
+ export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
454
593
  }
455
594
 
456
- export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
595
+ /**
596
+ * @deprecated
597
+ */
598
+ export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
457
599
  }
458
600
 
459
601
  export interface GetDistrict {
@@ -477,15 +619,16 @@ export interface GetMonopolyAccounts {
477
619
  }
478
620
 
479
621
  export interface GetMyAccounts {
622
+ filter?: AccountFilter;
480
623
  }
481
624
 
482
- export interface GetMyRideOffers {
625
+ export interface GetMyRides {
483
626
  accountId?: string;
484
627
  maxSize?: number;
485
628
  timeRange?: InstantRange;
486
629
  }
487
630
 
488
- export interface GetMyRides {
631
+ export interface GetMySeries {
489
632
  accountId?: string;
490
633
  maxSize?: number;
491
634
  timeRange?: InstantRange;
@@ -500,20 +643,36 @@ export interface GetMyUserProfile {
500
643
  export interface GetNutsStates {
501
644
  }
502
645
 
503
- export interface GetPotentialDrivers {
646
+ export interface GetOneSeries {
647
+ rideSeriesId?: string;
648
+ }
649
+
650
+ /**
651
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
652
+
653
+ */
654
+ export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
655
+ }
656
+
657
+ /**
658
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
659
+
660
+ */
661
+ export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
662
+ }
663
+
664
+ /**
665
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
666
+
667
+ */
668
+ export interface GetPotentialDriversAbstract {
504
669
  fromDistrict?: string;
505
670
  mobility?: Mobility;
506
- rideType?: RideType;
507
671
  toDistrict?: string;
672
+ vehicleType?: VehicleType;
508
673
  weightInKg?: number;
509
674
  }
510
675
 
511
- export interface GetPotentialRides {
512
- accountId?: string;
513
- maxSize?: number;
514
- timeRange?: InstantRange;
515
- }
516
-
517
676
  export interface GetRide {
518
677
  rideId?: string;
519
678
  }
@@ -521,14 +680,53 @@ export interface GetRide {
521
680
  export interface GetRideCsv extends RideStatisticsQuery {
522
681
  }
523
682
 
524
- export interface GetRideData extends RideStatisticsQuery {
525
- rideOwner?: string;
683
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
684
+ accountId?: string;
685
+ }
686
+
687
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
688
+ accountId?: string;
526
689
  }
527
690
 
528
691
  export interface GetRideLog {
529
692
  rideId?: string;
530
693
  }
531
694
 
695
+ export interface GetRideOrSeries {
696
+ id?: string;
697
+ }
698
+
699
+ export interface GetRidesForDriver {
700
+ accountId?: string;
701
+ maxSize?: number;
702
+ timeRange?: InstantRange;
703
+ }
704
+
705
+ export interface GetRidesInMarketplace {
706
+ accountId?: string;
707
+ maxSize?: number;
708
+ timeRange?: InstantRange;
709
+ }
710
+
711
+ export interface GetRidesInSeries {
712
+ rideSeriesId?: string;
713
+ }
714
+
715
+ export interface GetSeriesForDriver {
716
+ accountId?: string;
717
+ maxSize?: number;
718
+ timeRange?: InstantRange;
719
+ }
720
+
721
+ export interface GetSeriesInMarketplace {
722
+ accountId?: string;
723
+ maxSize?: number;
724
+ }
725
+
726
+ export interface GetSeriesLog {
727
+ rideSeriesId?: string;
728
+ }
729
+
532
730
  export interface GetTeam {
533
731
  teamId?: string;
534
732
  }
@@ -555,6 +753,14 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
555
753
  teamPermission?: TeamPermission;
556
754
  }
557
755
 
756
+ export interface IGetPotentialDrivers {
757
+ fromDistrict?: string;
758
+ mobility?: Mobility;
759
+ toDistrict?: string;
760
+ vehicleType?: VehicleType;
761
+ weightInKg?: number;
762
+ }
763
+
558
764
  export interface ImpersonateUser {
559
765
  userId?: string;
560
766
  }
@@ -595,6 +801,23 @@ export interface IsoState {
595
801
  nutsCode?: string;
596
802
  }
597
803
 
804
+ export interface Metric {
805
+ clientId?: string;
806
+ clientSegment?: number[];
807
+ maxSize?: number;
808
+ maxTimeout?: string;
809
+ tokenId?: string;
810
+ type?: string;
811
+ updates?: string[];
812
+ }
813
+
814
+ /**
815
+ * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
816
+ */
817
+ export interface MinimizedRideSeries extends RideSeries, RideOrMinimizedSeries {
818
+ info?: SeriesRideInfo;
819
+ }
820
+
598
821
  export interface NutsDistrict {
599
822
  code?: string;
600
823
  name?: string;
@@ -644,6 +867,24 @@ export interface PersonDimensions {
644
867
  export interface PhoneNumber {
645
868
  }
646
869
 
870
+ export interface PlanRide extends RideDriverModifyCommand {
871
+ plannedStartTime?: string;
872
+ }
873
+
874
+ export interface ReadUpdates {
875
+ clientId?: string;
876
+ maxSize?: number;
877
+ maxTimeout?: number;
878
+ tokenId?: string;
879
+ updateTypes?: EntityType[];
880
+ }
881
+
882
+ export interface ReadUpdatesResult {
883
+ clientSegment?: number[];
884
+ lastIndex?: number;
885
+ updates?: any[];
886
+ }
887
+
647
888
  export interface Region {
648
889
  nutsCode?: string;
649
890
  }
@@ -652,16 +893,11 @@ export interface RegisterAuthenticationToken extends UserUpdate {
652
893
  hashedToken?: string;
653
894
  }
654
895
 
655
- export interface RegisterDifferentEta extends FleetModifyCommand {
656
- destinationEta?: string;
657
- originEta?: string;
658
- }
659
-
660
- export interface RegisterDriveStatus extends FleetModifyCommand {
896
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
661
897
  driveStatus?: DriveStatus;
662
898
  }
663
899
 
664
- export interface RegisterDriverSynced extends FleetModifyCommand {
900
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
665
901
  }
666
902
 
667
903
  export interface RegisterEinsatz {
@@ -672,6 +908,14 @@ export interface RegisterEinsatz {
672
908
  export interface RemoveAccount extends AccountUpdate {
673
909
  }
674
910
 
911
+ export interface RemoveOperations extends AccountUpdate {
912
+ operateAccount?: string;
913
+ }
914
+
915
+ export interface RemoveOperator extends AccountUpdate {
916
+ operator?: string;
917
+ }
918
+
675
919
  export interface RemoveSettings extends AccountUpdate {
676
920
  type?: IntegrationType;
677
921
  }
@@ -688,6 +932,13 @@ export interface ReportIssue {
688
932
  issue?: string;
689
933
  }
690
934
 
935
+ /**
936
+ * Can only report delays when ride has started and has not arrived at destination.
937
+ */
938
+ export interface ReportRideDelay extends RideDriverModifyCommand {
939
+ minutes?: number;
940
+ }
941
+
691
942
  export interface RequestDrivePermission extends AccountUpdate {
692
943
  drivePermissionId?: string;
693
944
  info?: DrivePermissionInfoRequest;
@@ -702,16 +953,31 @@ export interface RequestUserReset {
702
953
  email?: string;
703
954
  }
704
955
 
956
+ /**
957
+ * Resets the lastIndex position of your token.
958
+ */
959
+ export interface ResetPosition {
960
+ index?: number;
961
+ timestamp?: string;
962
+ tokenId?: string;
963
+ }
964
+
965
+ export interface ReturnRide extends RideDriverModifyCommand {
966
+ }
967
+
968
+ export interface ReturnRideSeries extends SeriesDriverCommand {
969
+ }
970
+
705
971
  export interface Review {
706
972
  comment?: string;
707
973
  stars?: number;
708
974
  }
709
975
 
710
- export interface ReviewRideAsDriver extends FleetModifyCommand {
976
+ export interface ReviewRideAsBooker extends RideBookerCommand {
711
977
  review?: Review;
712
978
  }
713
979
 
714
- export interface ReviewRideAsRider extends RidePlannerCommand {
980
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
715
981
  review?: Review;
716
982
  }
717
983
 
@@ -722,6 +988,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
722
988
  drivePermissionId?: string;
723
989
  }
724
990
 
991
+ export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
992
+ }
993
+
725
994
  export interface RevokeSubscription extends AccountUpdate {
726
995
  subscriptionId?: string;
727
996
  }
@@ -729,17 +998,24 @@ export interface RevokeSubscription extends AccountUpdate {
729
998
  export interface RevokeToken extends TokenUpdate {
730
999
  }
731
1000
 
732
- export interface Ride {
1001
+ export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
733
1002
  /**
734
- * Derived from driveOwner != null
1003
+ * Derived from driver != null
735
1004
  */
736
1005
  accepted?: boolean;
1006
+ actualEndTime?: string;
1007
+ actualStartTime?: string;
1008
+ /**
1009
+ * Derived from driveStatus != null
1010
+ */
1011
+ arrived?: boolean;
737
1012
  /**
738
1013
  * Derived from bookedTime != null
739
1014
  */
740
1015
  booked?: boolean;
741
1016
  bookedTime?: string;
742
- bookingStatus?: BookingStatus;
1017
+ booker?: AccountOrTeamRef;
1018
+ bookerReview?: Review;
743
1019
  cancelReason?: string;
744
1020
  cancelled?: boolean;
745
1021
  /**
@@ -747,39 +1023,66 @@ export interface Ride {
747
1023
  */
748
1024
  completed?: boolean;
749
1025
  /**
750
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
1026
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
751
1027
  */
752
- destinationEta?: string;
1028
+ desiredEndTime?: string;
753
1029
  /**
754
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
1030
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
755
1031
  */
756
- destinationPta?: string;
757
- driveOwner?: AccountOrTeamRef;
1032
+ desiredStartTime?: string;
758
1033
  driveStatus?: DriveStatus;
1034
+ driver?: AccountOrTeamRef;
759
1035
  driverReview?: Review;
760
1036
  driverSyncStatus?: SyncStatus;
1037
+ endTimeDelay?: number;
1038
+ /**
1039
+ * Expected Time of Arrival at the Destination/Drop-off location.
1040
+ */
1041
+ expectedEndTime?: string;
1042
+ /**
1043
+ * Expected Time of Arrival at the Origin/Pick-up location.
1044
+ */
1045
+ expectedStartTime?: string;
761
1046
  info?: RideInfo;
762
1047
  /**
763
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
1048
+ * Derived from plannedStartTime != null
764
1049
  */
765
- originEta?: string;
1050
+ planned?: boolean;
766
1051
  /**
767
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
1052
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
768
1053
  */
769
- originPta?: string;
1054
+ plannedEndTime?: string;
1055
+ plannedStartTime?: string;
770
1056
  rideId?: string;
771
- rideOwner?: AccountOrTeamRef;
772
- riderReview?: Review;
1057
+ /**
1058
+ * The time until which rides can be found. It's the planned time or else the desired time.
1059
+ */
1060
+ searchEndTime?: string;
1061
+ /**
1062
+ * The time from which rides can be found. It's the planned time or else the desired time.
1063
+ */
1064
+ searchStartTime?: string;
1065
+ seriesInfo?: SeriesInfo;
1066
+ startTimeDelay?: number;
773
1067
  /**
774
1068
  * Derived from driveStatus != null
775
1069
  */
776
1070
  started?: boolean;
777
1071
  }
778
1072
 
1073
+ export interface RideBookerCommand extends RideCommand {
1074
+ }
1075
+
779
1076
  export interface RideCommand {
780
1077
  rideId?: string;
781
1078
  }
782
1079
 
1080
+ export interface RideDriverCommand extends RideCommand {
1081
+ }
1082
+
1083
+ export interface RideDriverModifyCommand extends RideDriverCommand {
1084
+ }
1085
+
783
1086
  /**
784
1087
  * All durations in seconds
785
1088
  */
@@ -792,39 +1095,41 @@ export interface RideDuration {
792
1095
 
793
1096
  export interface RideFilter {
794
1097
  bookingStatuses?: BookingStatus[];
795
- directions?: Direction[];
796
1098
  driveStatuses?: DriveStatus[];
797
1099
  driverAccountNames?: string[];
798
1100
  driverTeamNames?: string[];
1101
+ entityType?: EntityType;
799
1102
  hasInfection?: boolean;
800
1103
  heavyWeight?: boolean;
801
1104
  mobilities?: Mobility[];
1105
+ purposes?: RidePurpose[];
802
1106
  region?: Region;
803
1107
  requiresMonitoring?: boolean;
804
1108
  requiresOxygen?: boolean;
805
1109
  requiresSuctionAspirator?: boolean;
806
- rideType?: RideType;
807
1110
  riderAccountNames?: string[];
808
1111
  riderTeamNames?: string[];
809
1112
  timeRange?: InstantRange;
1113
+ unfoldRideSeries?: boolean;
1114
+ vehicleType?: VehicleType;
810
1115
  }
811
1116
 
812
1117
  export interface RideFilterCount {
813
1118
  bookingStatuses?: { [P in BookingStatus]?: number };
814
- directions?: { [P in Direction]?: number };
815
1119
  driveStatuses?: { [P in DriveStatus]?: number };
816
1120
  driverAccountNames?: { [index: string]: number };
817
1121
  driverTeamNames?: { [index: string]: number };
818
1122
  hasInfection?: number;
819
1123
  heavyWeight?: number;
820
1124
  mobilities?: { [P in Mobility]?: number };
1125
+ purposes?: { [P in RidePurpose]?: number };
821
1126
  requiresMonitoring?: number;
822
1127
  requiresOxygen?: number;
823
1128
  requiresSuctionAspirator?: number;
824
- rideTypes?: { [P in RideType]?: number };
825
1129
  riderAccountNames?: { [index: string]: number };
826
1130
  riderTeamNames?: { [index: string]: number };
827
1131
  total?: number;
1132
+ vehicleTypes?: { [P in VehicleType]?: number };
828
1133
  }
829
1134
 
830
1135
  export interface RideIdResult {
@@ -834,26 +1139,9 @@ export interface RideIdResult {
834
1139
  /**
835
1140
  * Information about the ride, from the creator of the ride
836
1141
  */
837
- export interface RideInfo {
838
- ambulanceInfo?: AmbulanceInfo;
1142
+ export interface RideInfo extends GenericRideInfo {
839
1143
  appointment?: Appointment;
840
- attendantsPresent?: number;
841
- comment?: string;
842
- dimensions?: PersonDimensions;
843
- direction?: Direction;
844
- distanceInMeters?: number;
845
- from?: AddressInfo;
846
- /**
847
- * Derived from weightInKg != null
848
- */
849
- heavyWeight?: boolean;
850
- mobility?: Mobility;
851
- patient?: Person;
852
- plannedDuration?: RideDuration;
853
- preferredDriver?: string;
854
- rideType?: RideType;
855
- to?: AddressInfo;
856
- weightInKg?: number;
1144
+ purpose?: RidePurpose;
857
1145
  }
858
1146
 
859
1147
  export interface RideLog {
@@ -872,22 +1160,95 @@ export interface RideLog {
872
1160
  token?: boolean;
873
1161
  }
874
1162
 
875
- export interface RideOfferInfo {
876
- appointment?: Appointment;
1163
+ export interface RideOperatorCommand extends RideCommand {
1164
+ }
1165
+
1166
+ export interface RideOrMinimizedSeries {
1167
+ bookingStatus?: BookingStatus;
1168
+ entityType?: EntityType;
1169
+ info?: GenericRideInfo;
877
1170
  }
878
1171
 
879
- export interface RidePlannerCommand extends RideCommand {
1172
+ export interface RideOrSeries {
1173
+ bookingStatus?: BookingStatus;
1174
+ entityType?: EntityType;
1175
+ info?: GenericRideInfo;
1176
+ }
1177
+
1178
+ /**
1179
+ * RideSeries is a grouped ride series. A singular object, that is later split into individual rides, once a driver has accepted the series as a group.
1180
+ */
1181
+ export interface RideSeries extends RideOrSeries {
1182
+ /**
1183
+ * Derived from driver != null
1184
+ */
1185
+ accepted?: boolean;
1186
+ activeRideCount?: number;
1187
+ /**
1188
+ * Derived from bookedTime != null
1189
+ */
1190
+ booked?: boolean;
1191
+ bookedTime?: string;
1192
+ booker?: AccountOrTeamRef;
1193
+ cancelReason?: string;
1194
+ cancelled?: boolean;
1195
+ driver?: AccountOrTeamRef;
1196
+ info?: SeriesRideInfo;
1197
+ rideSeriesId?: string;
1198
+ rides?: Ride[];
1199
+ ridesSummaries?: RideSummary[];
1200
+ searchEndTime?: string;
1201
+ searchStartTime?: string;
1202
+ }
1203
+
1204
+ export interface RideSeriesIdResult {
1205
+ rideSeriesId?: string;
1206
+ }
1207
+
1208
+ export interface RideSeriesUpdate {
1209
+ after?: RideSeries;
1210
+ before?: RideSeries;
1211
+ entityId?: string;
1212
+ eventType?: string;
1213
+ index?: number;
1214
+ timestamp?: string;
1215
+ type: "rideseries";
1216
+ }
1217
+
1218
+ export interface RideSeriesUtils {
880
1219
  }
881
1220
 
882
1221
  export interface RideStatisticsQuery {
883
1222
  dateRange?: DateRange;
1223
+ zoneId?: string;
884
1224
  }
885
1225
 
886
- export interface RideTypeSpecificFilter {
887
- type: "ambulance" | "taxi";
1226
+ /**
1227
+ * Individual ride timing within a series. Once a ride series is split, you cannot add rides, only remove
1228
+ */
1229
+ export interface RideSummary {
1230
+ appointmentTime?: string;
1231
+ returnTrip?: boolean;
1232
+ rideId?: string;
1233
+ }
1234
+
1235
+ export interface RideSystemCommand extends RideCommand {
1236
+ }
1237
+
1238
+ export interface RideUpcaster {
1239
+ }
1240
+
1241
+ export interface RideUpdate {
1242
+ after?: Ride;
1243
+ before?: Ride;
1244
+ entityId?: string;
1245
+ eventType?: string;
1246
+ index?: number;
1247
+ timestamp?: string;
1248
+ type: "ride";
888
1249
  }
889
1250
 
890
- export interface Role<T> {
1251
+ export interface Role {
891
1252
  }
892
1253
 
893
1254
  /**
@@ -895,7 +1256,14 @@ export interface Role<T> {
895
1256
  */
896
1257
  export interface SaveRide extends CreateRideCommand {
897
1258
  info?: RideInfo;
898
- owner?: AccountOrTeamRef;
1259
+ }
1260
+
1261
+ export interface SaveRideSeries extends CreateSeriesCommand {
1262
+ rideSummaries?: RideSummary[];
1263
+ }
1264
+
1265
+ export interface SecondaryTokenPermissionCommand extends TokenUpdate {
1266
+ accountId?: string;
899
1267
  }
900
1268
 
901
1269
  export interface SendConfirmationEmail {
@@ -909,6 +1277,7 @@ export interface SendEmail {
909
1277
  export interface SendFreshdeskNewTicket {
910
1278
  email?: string;
911
1279
  message?: string;
1280
+ subject?: string;
912
1281
  }
913
1282
 
914
1283
  export interface SendInvitationEmail {
@@ -921,6 +1290,53 @@ export interface SendSlack {
921
1290
  message?: string;
922
1291
  }
923
1292
 
1293
+ export interface SeriesBookerCommand extends SeriesCommand {
1294
+ }
1295
+
1296
+ export interface SeriesCommand {
1297
+ rideSeriesId?: string;
1298
+ }
1299
+
1300
+ export interface SeriesCommandWithSeparateEvent {
1301
+ rideSeriesId?: string;
1302
+ }
1303
+
1304
+ export interface SeriesDriverCommand extends SeriesCommand {
1305
+ }
1306
+
1307
+ /**
1308
+ * Information about a ride that is part of series.
1309
+ */
1310
+ export interface SeriesInfo {
1311
+ desyncedFromSeries?: boolean;
1312
+ positionInSeries?: number;
1313
+ returnTrip?: boolean;
1314
+ rideSeriesId?: string;
1315
+ totalRidesInSeries?: number;
1316
+ }
1317
+
1318
+ export interface SeriesOperatorCommand extends SeriesCommand {
1319
+ }
1320
+
1321
+ /**
1322
+ * Information about the ride, from the creator of the ride
1323
+ */
1324
+ export interface SeriesRideInfo extends GenericRideInfo {
1325
+ purpose?: SeriesPurpose;
1326
+ }
1327
+
1328
+ export interface SetOperations extends AccountUpdate {
1329
+ operateAccounts?: string[];
1330
+ }
1331
+
1332
+ export interface SetOperator extends AccountUpdate {
1333
+ operator?: string;
1334
+ }
1335
+
1336
+ export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
1337
+ accountPermission?: AccountPermission;
1338
+ }
1339
+
924
1340
  export interface SetSettings extends AccountUpdate {
925
1341
  settings?: any;
926
1342
  }
@@ -961,7 +1377,7 @@ export interface SubscriptionInfo extends TimedPermission {
961
1377
  service?: Service;
962
1378
  }
963
1379
 
964
- export interface TaxiFilter extends RideTypeSpecificFilter {
1380
+ export interface TaxiFilter extends DrivePermissionFilter {
965
1381
  allowedMobilities?: Mobility[];
966
1382
  type: "taxi";
967
1383
  }
@@ -997,10 +1413,11 @@ export interface TimedPermission {
997
1413
  }
998
1414
 
999
1415
  export interface Token {
1000
- accountPermission?: AccountPermission;
1416
+ accountPermissions?: AccountPermission[];
1001
1417
  createdBy?: string;
1002
1418
  info?: TokenInfo;
1003
1419
  lastUpdatedBy?: string;
1420
+ owner?: string;
1004
1421
  revoked?: boolean;
1005
1422
  tokenId?: string;
1006
1423
  }
@@ -1028,9 +1445,34 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1028
1445
  accountPermission?: AccountPermission;
1029
1446
  }
1030
1447
 
1031
- export interface UpdateRideBooking extends RidePlannerCommand {
1448
+ export interface UpdatePosition {
1449
+ clientSegment?: number[];
1450
+ lastIndex?: number;
1451
+ tokenId?: string;
1452
+ }
1453
+
1454
+ export interface UpdateRide extends RideBookerCommand {
1455
+ booker?: AccountOrTeamRef;
1032
1456
  info?: RideInfo;
1033
- owner?: AccountOrTeamRef;
1457
+ }
1458
+
1459
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1460
+ plannedStartTime?: string;
1461
+ }
1462
+
1463
+ export interface UpdateRideSeries extends SeriesCommandWithSeparateEvent {
1464
+ booker?: AccountOrTeamRef;
1465
+ info?: SeriesRideInfo;
1466
+ rideSummaries?: RideSummary[];
1467
+ }
1468
+
1469
+ export interface UpdateRideSeriesEvent extends SeriesBookerCommand {
1470
+ addRides?: string[];
1471
+ booker?: AccountOrTeamRef;
1472
+ cancelRides?: string[];
1473
+ info?: SeriesRideInfo;
1474
+ rideSummaries?: RideSummary[];
1475
+ updateRides?: string[];
1034
1476
  }
1035
1477
 
1036
1478
  export interface UpdateTeam extends TeamUpdate {
@@ -1046,6 +1488,9 @@ export interface UpdateUserInfo extends UserEdit {
1046
1488
  info?: UserInfo;
1047
1489
  }
1048
1490
 
1491
+ export interface UserAndTokenUpcaster {
1492
+ }
1493
+
1049
1494
  export interface UserCommand {
1050
1495
  userId?: string;
1051
1496
  }
@@ -1086,36 +1531,42 @@ export interface ZonedTimeRange {
1086
1531
  start?: Date;
1087
1532
  }
1088
1533
 
1089
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1534
+ export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
1090
1535
 
1091
1536
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1092
1537
 
1093
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1538
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1094
1539
 
1095
- export type Direction = "admission" | "relocation" | "discharge" | "consultation";
1540
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1096
1541
 
1097
1542
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1098
1543
 
1544
+ export type EntityType = "ride" | "rideseries";
1545
+
1099
1546
  export type GeometryUnion = GeoPolygon | GeoMultiPolygon;
1100
1547
 
1101
1548
  export type InsuranceType = "public_insurance" | "private_insurance" | "german_accident_insurance" | "no_or_unknown_insurance";
1102
1549
 
1103
1550
  export type IntegrationType = "dispolive" | "celios";
1104
1551
 
1105
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1552
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1106
1553
 
1107
- export type RideType = "taxi" | "ambulance";
1554
+ export type OrganisationType = "medical" | "fleet" | "operator";
1108
1555
 
1109
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1556
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1110
1557
 
1111
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1558
+ export type SeriesPurpose = "consultation";
1559
+
1560
+ export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";
1112
1561
 
1113
1562
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1114
1563
 
1115
- export type StandaloneService = "rideplanning" | "driveplanning";
1564
+ export type StandaloneService = "pro_medical" | "pro_fleet" | "pro_operator";
1116
1565
 
1117
1566
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1118
1567
 
1119
- export type TeamRole = "driveplanner" | "rideplanner";
1568
+ export type TeamRole = "dispatcher" | "ridebooker";
1120
1569
 
1121
1570
  export type UserRole = "superadmin";
1571
+
1572
+ 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.801-test-server",
3
+ "version": "0.1.801",
4
4
  "types": "common.d.ts"
5
5
  }
File without changes