@moxi.gmbh/moxi-typescriptmodels 0.1.1151-test-server → 0.1.1161-test-server

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.
Files changed (2) hide show
  1. package/common.d.ts +375 -252
  2. package/package.json +1 -1
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
+ dispatcher?: AccountOrTeamRef;
4
8
  }
5
9
 
6
10
  export interface AcceptUserAgreement extends UserEdit {
@@ -8,7 +12,7 @@ export interface AcceptUserAgreement extends UserEdit {
8
12
  }
9
13
 
10
14
  export interface Account {
11
- accountId?: AccountId;
15
+ accountId?: string;
12
16
  /**
13
17
  * Derived from subscriptions
14
18
  */
@@ -24,28 +28,24 @@ export interface Account {
24
28
  }
25
29
 
26
30
  export interface AccountCommand {
27
- accountId?: AccountId;
31
+ accountId?: string;
28
32
  }
29
33
 
30
34
  export interface AccountFilter {
31
35
  activeServices?: Service[];
32
36
  }
33
37
 
34
- export interface AccountId {
35
- type?: Class<Account>;
36
- }
37
-
38
38
  export interface AccountInfo {
39
39
  address?: AddressInfo;
40
40
  defaultLanguage?: string;
41
41
  notificationEmails?: string[];
42
42
  phoneNumber?: PhoneNumber;
43
- zoneId?: ZoneId;
43
+ zoneId?: string;
44
44
  }
45
45
 
46
46
  export interface AccountOrTeamId {
47
- accountId?: AccountId;
48
- teamId?: TeamId;
47
+ accountId?: string;
48
+ teamId?: string;
49
49
  }
50
50
 
51
51
  export interface AccountOrTeamRef extends AccountOrTeamId {
@@ -54,20 +54,23 @@ export interface AccountOrTeamRef extends AccountOrTeamId {
54
54
  }
55
55
 
56
56
  export interface AccountPermission {
57
- accountId?: AccountId;
57
+ accountId?: string;
58
58
  roles?: AccountRole[];
59
59
  teamPermissions?: TeamPermission[];
60
60
  }
61
61
 
62
62
  export interface AccountPermissionCommand extends UserUpdate {
63
- accountId?: AccountId;
63
+ accountId?: string;
64
64
  }
65
65
 
66
66
  export interface AccountRef {
67
- accountId?: AccountId;
67
+ accountId?: string;
68
68
  name?: string;
69
69
  }
70
70
 
71
+ export interface AccountUpcaster {
72
+ }
73
+
71
74
  export interface AccountUpdate extends AccountCommand {
72
75
  }
73
76
 
@@ -103,16 +106,16 @@ export interface AdminConfirmUser extends UserUpdateAfterSignup {
103
106
 
104
107
  export interface AdminSetUserPassword {
105
108
  password?: string;
106
- userId?: UserId;
109
+ userId?: string;
107
110
  }
108
111
 
109
- export interface AmbulanceFilter extends RideTypeSpecificFilter {
112
+ export interface AmbulanceFilter extends DrivePermissionFilter {
110
113
  heavyWeightAllowed?: boolean;
111
114
  type: "ambulance";
112
115
  }
113
116
 
114
117
  /**
115
- * Filled if (and only if) rideType == ambulance
118
+ * Filled if (and only if) vehicleType == ambulance
116
119
  */
117
120
  export interface AmbulanceInfo {
118
121
  /**
@@ -133,26 +136,26 @@ export interface AmbulanceInfo {
133
136
  requiresSuctionAspirator?: boolean;
134
137
  }
135
138
 
136
- export interface AnnotatedElement {
137
- annotations?: Annotation[];
138
- declaredAnnotations?: Annotation[];
139
- }
139
+ /**
140
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
140
141
 
141
- export interface AnnotatedType extends AnnotatedElement {
142
- annotatedOwnerType?: AnnotatedType;
143
- type?: Type;
142
+ */
143
+ export interface AnonymizedGenericRideInfo extends GenericRideInfo {
144
144
  }
145
145
 
146
- export interface Annotation {
146
+ /**
147
+ * Information about the ride, from the creator of the ride
148
+ */
149
+ export interface AnonymizedRideInfo extends RideInfo {
147
150
  }
148
151
 
149
152
  export interface Appointment {
150
153
  pickup?: boolean;
151
- time?: Date;
154
+ time?: string;
152
155
  }
153
156
 
154
157
  export interface AssignDriver extends RideCommand {
155
- driveOwner?: AccountOrTeamRef;
158
+ driver?: AccountOrTeamRef;
156
159
  }
157
160
 
158
161
  export interface Attachment {
@@ -167,27 +170,47 @@ export interface AuthenticateWithToken extends UserUpdate {
167
170
 
168
171
  export interface AuthenticationResponse {
169
172
  authorizationHeader?: string;
170
- impersonator?: UserId;
173
+ impersonator?: string;
171
174
  result?: AuthenticationResult;
172
- sessionDeadline?: Date;
175
+ sessionDeadline?: string;
173
176
  userProfile?: UserProfile;
174
177
  }
175
178
 
176
179
  export interface AuthenticationService {
177
180
  }
178
181
 
182
+ export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
183
+ info?: GenericRideInfo;
184
+ updater?: AccountOrTeamRef;
185
+ }
186
+
187
+ export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
188
+ rides?: SingleRideUpdate[];
189
+ updater?: AccountOrTeamRef;
190
+ }
191
+
179
192
  export interface BookRide extends CreateRideCommand {
193
+ booker?: AccountOrTeamRef;
180
194
  info?: RideInfo;
181
- owner?: AccountOrTeamRef;
182
195
  }
183
196
 
184
- export interface CancelDrive extends FleetModifyCommand {
197
+ export interface BookRideSeries extends RideBookerSeriesCommand {
198
+ booker?: AccountOrTeamRef;
199
+ info?: GenericRideInfo;
200
+ rides?: SingleRide[];
185
201
  }
186
202
 
187
- export interface CancelRide extends RidePlannerCommand {
203
+ export interface CancelRide extends RideBookerCommand {
188
204
  reason?: string;
189
205
  }
190
206
 
207
+ export interface CancelRideSeries extends RideBookerSeriesCommand {
208
+ }
209
+
210
+ export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
211
+ updater?: AccountOrTeamRef;
212
+ }
213
+
191
214
  export interface CeliosSettings {
192
215
  certificate?: string;
193
216
  host?: string;
@@ -200,17 +223,11 @@ export interface CeliosSettings {
200
223
  export interface ChangeUserPassword {
201
224
  newPassword?: string;
202
225
  oldPassword?: string;
203
- userId?: UserId;
226
+ userId?: string;
204
227
  }
205
228
 
206
229
  export interface CheckIfUserSignedUp {
207
- userId?: UserId;
208
- }
209
-
210
- export interface Class<T> extends Serializable, GenericDeclaration, Type, AnnotatedElement, OfField<Class<any>>, Constable {
211
- }
212
-
213
- export interface Cloneable {
230
+ userId?: string;
214
231
  }
215
232
 
216
233
  export interface ConfirmAccount extends AccountCommand {
@@ -223,13 +240,16 @@ export interface ConfirmDrivePermission extends AccountUpdate {
223
240
  export interface ConfirmEverythingInAccount extends AccountCommand {
224
241
  }
225
242
 
243
+ export interface ConfirmRideSeries extends RideDriverSeriesCommand {
244
+ }
245
+
226
246
  export interface ConfirmSubscription extends AccountUpdate {
227
247
  subscriptionId?: string;
228
248
  }
229
249
 
230
250
  export interface ConfirmUser {
231
251
  token?: string;
232
- userId?: UserId;
252
+ userId?: string;
233
253
  }
234
254
 
235
255
  export interface ConfirmablePermission {
@@ -237,14 +257,11 @@ export interface ConfirmablePermission {
237
257
  revoked?: boolean;
238
258
  }
239
259
 
240
- export interface Constable {
241
- }
242
-
243
260
  export interface CreateAccount extends AccountCommand {
244
261
  autoConfirm?: boolean;
245
262
  criticalInfo?: CriticalAccountInfo;
246
263
  info?: AccountInfo;
247
- owner?: UserId;
264
+ owner?: string;
248
265
  requestService?: StandaloneService;
249
266
  }
250
267
 
@@ -253,8 +270,15 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
253
270
  timeRange?: InstantRange;
254
271
  }
255
272
 
256
- export interface CreateRideCommand extends RidePlannerCommand {
257
- owner?: AccountOrTeamId;
273
+ export interface CreateRideCommand extends RideBookerCommand {
274
+ booker?: AccountOrTeamId;
275
+ }
276
+
277
+ export interface CreateRideFromSeries extends RideDriverCommand {
278
+ booker?: AccountOrTeamRef;
279
+ driver?: AccountOrTeamRef;
280
+ info?: RideInfo;
281
+ seriesInfo?: SeriesInfo;
258
282
  }
259
283
 
260
284
  export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -263,7 +287,7 @@ export interface CreateSqueezeInPlan extends OptimizerMessage {
263
287
 
264
288
  export interface CreateTeam extends AccountCommand {
265
289
  info?: TeamInfo;
266
- teamId?: TeamId;
290
+ teamId?: string;
267
291
  }
268
292
 
269
293
  export interface CreateToken extends TokenCommand {
@@ -283,21 +307,13 @@ export interface CriticalAccountInfo {
283
307
  }
284
308
 
285
309
  export interface DateRange {
286
- end?: Date;
287
- start?: Date;
310
+ end?: string;
311
+ start?: string;
288
312
  }
289
313
 
290
314
  export interface DeleteUser extends UserEdit {
291
315
  }
292
316
 
293
- export interface Dimension extends Dimension2D, Serializable {
294
- }
295
-
296
- export interface Dimension2D extends Cloneable {
297
- height?: number;
298
- width?: number;
299
- }
300
-
301
317
  export interface DispoliveSettings {
302
318
  key?: string;
303
319
  type: "dispolive";
@@ -306,7 +322,7 @@ export interface DispoliveSettings {
306
322
 
307
323
  export interface District {
308
324
  info?: DistrictInfo;
309
- polygons?: Polygon[];
325
+ polygons?: any[];
310
326
  }
311
327
 
312
328
  export interface DistrictInfo {
@@ -330,14 +346,18 @@ export interface DrivePermission {
330
346
  revoked?: boolean;
331
347
  }
332
348
 
349
+ export interface DrivePermissionFilter {
350
+ type: "ambulance" | "taxi";
351
+ }
352
+
333
353
  export interface DrivePermissionInfo {
334
- filter?: RideTypeSpecificFilterUnion;
354
+ filter?: DrivePermissionFilterUnion;
335
355
  monopoly?: boolean;
336
356
  regions?: Region[];
337
357
  }
338
358
 
339
359
  export interface DrivePermissionInfoRequest {
340
- filter?: RideTypeSpecificFilterUnion;
360
+ filter?: DrivePermissionFilterUnion;
341
361
  regions?: Region[];
342
362
  }
343
363
 
@@ -377,7 +397,7 @@ export interface FetchGoogleGeoLocation {
377
397
  }
378
398
 
379
399
  export interface FetchGoogleRoute {
380
- departureTime?: Date;
400
+ departureTime?: string;
381
401
  from?: GeoLocation;
382
402
  to?: GeoLocation;
383
403
  }
@@ -400,7 +420,7 @@ export interface FindAccounts {
400
420
  }
401
421
 
402
422
  export interface FindMyAcceptedRides {
403
- accountId?: AccountId;
423
+ accountId?: string;
404
424
  descending?: boolean;
405
425
  filter?: RideFilter;
406
426
  maxSize?: number;
@@ -411,15 +431,23 @@ export interface FindMyAcceptedRides {
411
431
  * @deprecated
412
432
  */
413
433
  export interface FindMyRideOffers {
414
- accountId?: AccountId;
434
+ accountId?: string;
415
435
  descending?: boolean;
416
436
  filter?: RideFilter;
417
437
  maxSize?: number;
418
438
  term?: string;
419
439
  }
420
440
 
441
+ export interface FindMyRideSeries {
442
+ accountId?: string;
443
+ descending?: boolean;
444
+ maxSize?: number;
445
+ term?: string;
446
+ timeRange?: InstantRange;
447
+ }
448
+
421
449
  export interface FindMyRides {
422
- accountId?: AccountId;
450
+ accountId?: string;
423
451
  descending?: boolean;
424
452
  filter?: RideFilter;
425
453
  maxSize?: number;
@@ -427,19 +455,26 @@ export interface FindMyRides {
427
455
  }
428
456
 
429
457
  export interface FindMyTokens {
430
- accountId?: AccountId;
431
- teamId?: TeamId;
458
+ accountId?: string;
459
+ teamId?: string;
432
460
  term?: string;
433
461
  }
434
462
 
435
463
  export interface FindMyUsers {
436
- accountId?: AccountId;
437
- teamId?: TeamId;
464
+ accountId?: string;
465
+ teamId?: string;
438
466
  term?: string;
439
467
  }
440
468
 
469
+ export interface FindPotentialRideSeries {
470
+ accountId?: string;
471
+ descending?: boolean;
472
+ filter?: RideInfoFilter;
473
+ maxSize?: number;
474
+ }
475
+
441
476
  export interface FindPotentialRides {
442
- accountId?: AccountId;
477
+ accountId?: string;
443
478
  descending?: boolean;
444
479
  filter?: RideFilter;
445
480
  maxSize?: number;
@@ -466,20 +501,35 @@ export interface FindUsers {
466
501
  term?: string;
467
502
  }
468
503
 
469
- export interface FleetCommand extends RideCommand {
470
- }
471
-
472
- export interface FleetModifyCommand extends FleetCommand {
473
- }
474
-
475
504
  export interface GenerateToken {
476
505
  accountPermission?: AccountPermission;
477
506
  info?: TokenInfo;
478
- tokenId?: TokenId;
507
+ tokenId?: string;
479
508
  }
480
509
 
481
- export interface GenericDeclaration extends AnnotatedElement {
482
- typeParameters?: TypeVariable<any>[];
510
+ /**
511
+ * Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
512
+
513
+ */
514
+ export interface GenericRideInfo {
515
+ ambulanceInfo?: AmbulanceInfo;
516
+ attendantsPresent?: number;
517
+ comment?: string;
518
+ dimensions?: PersonDimensions;
519
+ distanceInMeters?: number;
520
+ from?: AddressInfo;
521
+ /**
522
+ * Derived from weightInKg != null
523
+ */
524
+ heavyWeight?: boolean;
525
+ mobility?: Mobility;
526
+ patient?: Person;
527
+ plannedDuration?: RideDuration;
528
+ preferredDriver?: string;
529
+ purpose?: RidePurpose;
530
+ to?: AddressInfo;
531
+ vehicleType?: VehicleType;
532
+ weightInKg?: number;
483
533
  }
484
534
 
485
535
  export interface GeoJson {
@@ -509,7 +559,7 @@ export interface Geometry {
509
559
  }
510
560
 
511
561
  export interface GetAccount {
512
- accountId?: AccountId;
562
+ accountId?: string;
513
563
  }
514
564
 
515
565
  export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
@@ -538,8 +588,15 @@ export interface GetIsoStates {
538
588
  export interface GetMonopolyAccounts {
539
589
  }
540
590
 
591
+ export interface GetMyAcceptedRideSeries {
592
+ accountId?: string;
593
+ descending?: boolean;
594
+ maxSize?: number;
595
+ timeRange?: InstantRange;
596
+ }
597
+
541
598
  export interface GetMyAcceptedRides {
542
- accountId?: AccountId;
599
+ accountId?: string;
543
600
  maxSize?: number;
544
601
  timeRange?: InstantRange;
545
602
  }
@@ -552,13 +609,19 @@ export interface GetMyAccounts {
552
609
  * @deprecated
553
610
  */
554
611
  export interface GetMyRideOffers {
555
- accountId?: AccountId;
612
+ accountId?: string;
613
+ maxSize?: number;
614
+ timeRange?: InstantRange;
615
+ }
616
+
617
+ export interface GetMyRideSeries {
618
+ accountId?: string;
556
619
  maxSize?: number;
557
620
  timeRange?: InstantRange;
558
621
  }
559
622
 
560
623
  export interface GetMyRides {
561
- accountId?: AccountId;
624
+ accountId?: string;
562
625
  maxSize?: number;
563
626
  timeRange?: InstantRange;
564
627
  }
@@ -575,42 +638,60 @@ export interface GetNutsStates {
575
638
  export interface GetPotentialDrivers {
576
639
  fromDistrict?: string;
577
640
  mobility?: Mobility;
578
- rideType?: RideType;
579
641
  toDistrict?: string;
642
+ vehicleType?: VehicleType;
580
643
  weightInKg?: number;
581
644
  }
582
645
 
646
+ export interface GetPotentialRideSeries {
647
+ accountId?: string;
648
+ maxSize?: number;
649
+ }
650
+
583
651
  export interface GetPotentialRides {
584
- accountId?: AccountId;
652
+ accountId?: string;
585
653
  maxSize?: number;
586
654
  timeRange?: InstantRange;
587
655
  }
588
656
 
589
657
  export interface GetRide {
590
- rideId?: RideId;
658
+ rideId?: string;
591
659
  }
592
660
 
593
661
  export interface GetRideCsv extends RideStatisticsQuery {
594
662
  }
595
663
 
596
- export interface GetRideData extends RideStatisticsQuery {
597
- rideOwner?: AccountId;
664
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
665
+ accountId?: string;
666
+ }
667
+
668
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
669
+ accountId?: string;
598
670
  }
599
671
 
600
672
  export interface GetRideLog {
601
- rideId?: RideId;
673
+ rideId?: string;
674
+ }
675
+
676
+ export interface GetRideSeries {
677
+ rideSeriesId?: string;
678
+ }
679
+
680
+ export interface GetRidesInSeries {
681
+ filter?: RideFilter;
682
+ rideSeriesId?: string;
602
683
  }
603
684
 
604
685
  export interface GetTeam {
605
- teamId?: TeamId;
686
+ teamId?: string;
606
687
  }
607
688
 
608
689
  export interface GetToken {
609
- tokenId?: TokenId;
690
+ tokenId?: string;
610
691
  }
611
692
 
612
693
  export interface GetUserProfile {
613
- userId?: UserId;
694
+ userId?: string;
614
695
  }
615
696
 
616
697
  export interface GiveDrivePermission extends AccountUpdate {
@@ -628,15 +709,12 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
628
709
  }
629
710
 
630
711
  export interface ImpersonateUser {
631
- userId?: UserId;
632
- }
633
-
634
- export interface InetAddress extends Serializable {
712
+ userId?: string;
635
713
  }
636
714
 
637
715
  export interface InstantRange {
638
- end?: Date;
639
- start?: Date;
716
+ end?: string;
717
+ start?: string;
640
718
  }
641
719
 
642
720
  export interface Insurer {
@@ -645,7 +723,7 @@ export interface Insurer {
645
723
  }
646
724
 
647
725
  export interface Invite {
648
- accountId?: AccountId;
726
+ accountId?: string;
649
727
  invitedBy?: string;
650
728
  }
651
729
 
@@ -659,7 +737,7 @@ export interface InviteUser extends UserCommand {
659
737
  * Ip4 or ip6 range in CIDR format
660
738
  */
661
739
  export interface IpRange {
662
- ip?: InetAddress;
740
+ ip?: string;
663
741
  range?: number;
664
742
  }
665
743
 
@@ -687,11 +765,6 @@ export interface NutsSubState {
687
765
  name?: string;
688
766
  }
689
767
 
690
- export interface OfField<F> extends TypeDescriptor {
691
- array?: boolean;
692
- primitive?: boolean;
693
- }
694
-
695
768
  export interface OffsetTimeRange {
696
769
  end?: Date;
697
770
  start?: Date;
@@ -702,7 +775,7 @@ export interface OptimizerMessage {
702
775
 
703
776
  export interface Person {
704
777
  address?: AddressInfo;
705
- birthDay?: Date;
778
+ birthDay?: string;
706
779
  email?: string;
707
780
  firstName?: string;
708
781
  insuranceNumber?: string;
@@ -724,45 +797,8 @@ export interface PersonDimensions {
724
797
  export interface PhoneNumber {
725
798
  }
726
799
 
727
- export interface Point extends Point2D, Serializable {
728
- }
729
-
730
- export interface Point2D extends Cloneable {
731
- x?: number;
732
- y?: number;
733
- }
734
-
735
- export interface Polygon extends Shape, Serializable {
736
- /**
737
- * @deprecated
738
- */
739
- boundingBox?: Rectangle;
740
- npoints?: number;
741
- xpoints?: number[];
742
- ypoints?: number[];
743
- }
744
-
745
- export interface Rectangle extends Rectangle2D, Shape, Serializable {
746
- location?: Point;
747
- rect?: Rectangle2D;
748
- size?: Dimension;
749
- }
750
-
751
- export interface Rectangle2D extends RectangularShape {
752
- }
753
-
754
- export interface RectangularShape extends Shape, Cloneable {
755
- centerX?: number;
756
- centerY?: number;
757
- empty?: boolean;
758
- height?: number;
759
- maxX?: number;
760
- maxY?: number;
761
- minX?: number;
762
- minY?: number;
763
- width?: number;
764
- x?: number;
765
- y?: number;
800
+ export interface PlanRide extends RideDriverModifyCommand {
801
+ plannedStartTime?: string;
766
802
  }
767
803
 
768
804
  export interface Region {
@@ -773,21 +809,16 @@ export interface RegisterAuthenticationToken extends UserUpdate {
773
809
  hashedToken?: string;
774
810
  }
775
811
 
776
- export interface RegisterDifferentEta extends FleetModifyCommand {
777
- destinationEta?: Date;
778
- originEta?: Date;
779
- }
780
-
781
- export interface RegisterDriveStatus extends FleetModifyCommand {
812
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
782
813
  driveStatus?: DriveStatus;
783
814
  }
784
815
 
785
- export interface RegisterDriverSynced extends FleetModifyCommand {
816
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
786
817
  }
787
818
 
788
819
  export interface RegisterEinsatz {
789
820
  einsatzNumber?: string;
790
- rideId?: RideId;
821
+ rideId?: string;
791
822
  }
792
823
 
793
824
  export interface RemoveAccount extends AccountUpdate {
@@ -801,7 +832,7 @@ export interface RemoveTeam extends TeamUpdate {
801
832
  }
802
833
 
803
834
  export interface RemoveTeamPermission extends AccountPermissionCommand {
804
- teamId?: TeamId;
835
+ teamId?: string;
805
836
  }
806
837
 
807
838
  export interface ReportIssue {
@@ -809,6 +840,13 @@ export interface ReportIssue {
809
840
  issue?: string;
810
841
  }
811
842
 
843
+ /**
844
+ * Can only report delays when ride has started and has not arrived at destination.
845
+ */
846
+ export interface ReportRideDelay extends RideDriverModifyCommand {
847
+ minutes?: number;
848
+ }
849
+
812
850
  export interface RequestDrivePermission extends AccountUpdate {
813
851
  drivePermissionId?: string;
814
852
  info?: DrivePermissionInfoRequest;
@@ -823,16 +861,22 @@ export interface RequestUserReset {
823
861
  email?: string;
824
862
  }
825
863
 
864
+ export interface ReturnRide extends RideDriverModifyCommand {
865
+ }
866
+
867
+ export interface ReturnRideSeries extends RideDriverSeriesCommand {
868
+ }
869
+
826
870
  export interface Review {
827
871
  comment?: string;
828
872
  stars?: number;
829
873
  }
830
874
 
831
- export interface ReviewRideAsDriver extends FleetModifyCommand {
875
+ export interface ReviewRideAsBooker extends RideBookerCommand {
832
876
  review?: Review;
833
877
  }
834
878
 
835
- export interface ReviewRideAsRider extends RidePlannerCommand {
879
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
836
880
  review?: Review;
837
881
  }
838
882
 
@@ -852,14 +896,22 @@ export interface RevokeToken extends TokenUpdate {
852
896
 
853
897
  export interface Ride {
854
898
  /**
855
- * Derived from driveOwner != null
899
+ * Derived from driver != null
856
900
  */
857
901
  accepted?: boolean;
902
+ actualEndTime?: string;
903
+ actualStartTime?: string;
904
+ /**
905
+ * Derived from driveStatus != null
906
+ */
907
+ arrived?: boolean;
858
908
  /**
859
909
  * Derived from bookedTime != null
860
910
  */
861
911
  booked?: boolean;
862
- bookedTime?: Date;
912
+ bookedTime?: string;
913
+ booker?: AccountOrTeamRef;
914
+ bookerReview?: Review;
863
915
  bookingStatus?: BookingStatus;
864
916
  cancelReason?: string;
865
917
  cancelled?: boolean;
@@ -868,37 +920,70 @@ export interface Ride {
868
920
  */
869
921
  completed?: boolean;
870
922
  /**
871
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
923
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
872
924
  */
873
- destinationEta?: Date;
925
+ desiredEndTime?: string;
874
926
  /**
875
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
927
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
876
928
  */
877
- destinationPta?: Date;
878
- driveOwner?: AccountOrTeamRef;
929
+ desiredStartTime?: string;
879
930
  driveStatus?: DriveStatus;
931
+ driver?: AccountOrTeamRef;
880
932
  driverReview?: Review;
881
933
  driverSyncStatus?: SyncStatus;
934
+ endTimeDelay?: number;
935
+ /**
936
+ * Expected Time of Arrival at the Destination/Drop-off location.
937
+ */
938
+ expectedEndTime?: string;
939
+ /**
940
+ * Expected Time of Arrival at the Origin/Pick-up location.
941
+ */
942
+ expectedStartTime?: string;
882
943
  info?: RideInfo;
883
944
  /**
884
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
945
+ * Derived from plannedStartTime != null
885
946
  */
886
- originEta?: Date;
947
+ planned?: boolean;
887
948
  /**
888
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
949
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
889
950
  */
890
- originPta?: Date;
891
- rideId?: RideId;
892
- rideOwner?: AccountOrTeamRef;
893
- riderReview?: Review;
951
+ plannedEndTime?: string;
952
+ plannedStartTime?: string;
953
+ rideId?: string;
954
+ /**
955
+ * The time until which rides can be found. It's the planned time or else the desired time.
956
+ */
957
+ searchEndTime?: string;
958
+ /**
959
+ * The time from which rides can be found. It's the planned time or else the desired time.
960
+ */
961
+ searchStartTime?: string;
962
+ seriesInfo?: SeriesInfo;
963
+ startTimeDelay?: number;
894
964
  /**
895
965
  * Derived from driveStatus != null
896
966
  */
897
967
  started?: boolean;
898
968
  }
899
969
 
970
+ export interface RideBookerCommand extends RideCommand {
971
+ }
972
+
973
+ export interface RideBookerSeriesCommand extends RideSeriesCommand {
974
+ }
975
+
900
976
  export interface RideCommand {
901
- rideId?: RideId;
977
+ rideId?: string;
978
+ }
979
+
980
+ export interface RideDriverCommand extends RideCommand {
981
+ }
982
+
983
+ export interface RideDriverModifyCommand extends RideDriverCommand {
984
+ }
985
+
986
+ export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
902
987
  }
903
988
 
904
989
  /**
@@ -913,47 +998,43 @@ export interface RideDuration {
913
998
 
914
999
  export interface RideFilter {
915
1000
  bookingStatuses?: BookingStatus[];
916
- directions?: Direction[];
917
1001
  driveStatuses?: DriveStatus[];
918
1002
  driverAccountNames?: string[];
919
1003
  driverTeamNames?: string[];
920
1004
  hasInfection?: boolean;
921
1005
  heavyWeight?: boolean;
922
1006
  mobilities?: Mobility[];
1007
+ purposes?: RidePurpose[];
923
1008
  region?: Region;
924
1009
  requiresMonitoring?: boolean;
925
1010
  requiresOxygen?: boolean;
926
1011
  requiresSuctionAspirator?: boolean;
927
- rideType?: RideType;
928
1012
  riderAccountNames?: string[];
929
1013
  riderTeamNames?: string[];
930
1014
  timeRange?: InstantRange;
1015
+ vehicleType?: VehicleType;
931
1016
  }
932
1017
 
933
1018
  export interface RideFilterCount {
934
1019
  bookingStatuses?: { [P in BookingStatus]?: number };
935
- directions?: { [P in Direction]?: number };
936
1020
  driveStatuses?: { [P in DriveStatus]?: number };
937
1021
  driverAccountNames?: { [index: string]: number };
938
1022
  driverTeamNames?: { [index: string]: number };
939
1023
  hasInfection?: number;
940
1024
  heavyWeight?: number;
941
1025
  mobilities?: { [P in Mobility]?: number };
1026
+ purposes?: { [P in RidePurpose]?: number };
942
1027
  requiresMonitoring?: number;
943
1028
  requiresOxygen?: number;
944
1029
  requiresSuctionAspirator?: number;
945
- rideTypes?: { [P in RideType]?: number };
946
1030
  riderAccountNames?: { [index: string]: number };
947
1031
  riderTeamNames?: { [index: string]: number };
948
1032
  total?: number;
949
- }
950
-
951
- export interface RideId {
952
- type?: Class<Ride>;
1033
+ vehicleTypes?: { [P in VehicleType]?: number };
953
1034
  }
954
1035
 
955
1036
  export interface RideIdResult {
956
- rideId?: RideId;
1037
+ rideId?: string;
957
1038
  }
958
1039
 
959
1040
  /**
@@ -965,7 +1046,6 @@ export interface RideInfo {
965
1046
  attendantsPresent?: number;
966
1047
  comment?: string;
967
1048
  dimensions?: PersonDimensions;
968
- direction?: Direction;
969
1049
  distanceInMeters?: number;
970
1050
  from?: AddressInfo;
971
1051
  /**
@@ -975,12 +1055,25 @@ export interface RideInfo {
975
1055
  mobility?: Mobility;
976
1056
  patient?: Person;
977
1057
  plannedDuration?: RideDuration;
978
- preferredDriver?: AccountId;
979
- rideType?: RideType;
1058
+ preferredDriver?: string;
1059
+ purpose?: RidePurpose;
980
1060
  to?: AddressInfo;
1061
+ vehicleType?: VehicleType;
981
1062
  weightInKg?: number;
982
1063
  }
983
1064
 
1065
+ export interface RideInfoFilter {
1066
+ hasInfection?: boolean;
1067
+ heavyWeight?: boolean;
1068
+ mobilities?: Mobility[];
1069
+ purposes?: RidePurpose[];
1070
+ region?: Region;
1071
+ requiresMonitoring?: boolean;
1072
+ requiresOxygen?: boolean;
1073
+ requiresSuctionAspirator?: boolean;
1074
+ vehicleType?: VehicleType;
1075
+ }
1076
+
984
1077
  export interface RideLog {
985
1078
  actingFor?: AccountOrTeamRef;
986
1079
  allowedViewers?: AccountOrTeamRef[];
@@ -993,7 +1086,7 @@ export interface RideLog {
993
1086
  isSuperAdmin?: boolean;
994
1087
  isToken?: boolean;
995
1088
  superAdmin?: boolean;
996
- timestamp?: Date;
1089
+ timestamp?: string;
997
1090
  token?: boolean;
998
1091
  }
999
1092
 
@@ -1001,17 +1094,47 @@ export interface RideOfferInfo {
1001
1094
  appointment?: Appointment;
1002
1095
  }
1003
1096
 
1004
- export interface RidePlannerCommand extends RideCommand {
1097
+ export interface RideSeries {
1098
+ accepted?: boolean;
1099
+ booked?: boolean;
1100
+ booker?: AccountOrTeamRef;
1101
+ cancelled?: boolean;
1102
+ confirmed?: boolean;
1103
+ driver?: AccountOrTeamRef;
1104
+ endTime?: string;
1105
+ info?: GenericRideInfo;
1106
+ rideSeriesId?: string;
1107
+ rides?: SingleRide[];
1108
+ startTime?: string;
1109
+ status?: RideSeriesStatus;
1110
+ }
1111
+
1112
+ export interface RideSeriesCommand {
1113
+ rideSeriesId?: string;
1114
+ }
1115
+
1116
+ export interface RideSeriesIdResult {
1117
+ rideSeriesId?: string;
1118
+ }
1119
+
1120
+ export interface RideSeriesPostConfirmCommand {
1121
+ rideSeriesId?: string;
1122
+ ridesToModify?: Ride[];
1123
+ }
1124
+
1125
+ export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
1005
1126
  }
1006
1127
 
1007
1128
  export interface RideStatisticsQuery {
1008
1129
  dateRange?: DateRange;
1009
- timezoneOrDefault?: ZoneId;
1010
- zoneId?: ZoneId;
1130
+ timezoneOrDefault?: string;
1131
+ zoneId?: string;
1011
1132
  }
1012
1133
 
1013
- export interface RideTypeSpecificFilter {
1014
- type: "ambulance" | "taxi";
1134
+ export interface RideSystemCommand extends RideCommand {
1135
+ }
1136
+
1137
+ export interface RideUpcaster {
1015
1138
  }
1016
1139
 
1017
1140
  export interface Role<T> {
@@ -1021,12 +1144,12 @@ export interface Role<T> {
1021
1144
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
1022
1145
  */
1023
1146
  export interface SaveRide extends CreateRideCommand {
1147
+ booker?: AccountOrTeamRef;
1024
1148
  info?: RideInfo;
1025
- owner?: AccountOrTeamRef;
1026
1149
  }
1027
1150
 
1028
1151
  export interface SendConfirmationEmail {
1029
- userId?: UserId;
1152
+ userId?: string;
1030
1153
  }
1031
1154
 
1032
1155
  export interface SendEmail {
@@ -1039,8 +1162,8 @@ export interface SendFreshdeskNewTicket {
1039
1162
  }
1040
1163
 
1041
1164
  export interface SendInvitationEmail {
1042
- accountIdOfInvite?: AccountId;
1043
- userId?: UserId;
1165
+ accountIdOfInvite?: string;
1166
+ userId?: string;
1044
1167
  }
1045
1168
 
1046
1169
  export interface SendSlack {
@@ -1048,7 +1171,12 @@ export interface SendSlack {
1048
1171
  message?: string;
1049
1172
  }
1050
1173
 
1051
- export interface Serializable {
1174
+ /**
1175
+ * Information about a ride that is part of series.
1176
+ */
1177
+ export interface SeriesInfo {
1178
+ returnTrip?: boolean;
1179
+ rideSeriesId?: string;
1052
1180
  }
1053
1181
 
1054
1182
  export interface SetSettings extends AccountUpdate {
@@ -1058,21 +1186,16 @@ export interface SetSettings extends AccountUpdate {
1058
1186
  export interface SetUserPassword {
1059
1187
  confirmationCode?: string;
1060
1188
  password?: string;
1061
- userId?: UserId;
1189
+ userId?: string;
1062
1190
  }
1063
1191
 
1064
1192
  export interface SetUserRole extends UserUpdate {
1065
1193
  role?: UserRole;
1066
1194
  }
1067
1195
 
1068
- export interface Shape {
1069
- bounds?: Rectangle;
1070
- bounds2D?: Rectangle2D;
1071
- }
1072
-
1073
1196
  export interface SignInUser {
1074
1197
  password?: string;
1075
- userId?: UserId;
1198
+ userId?: string;
1076
1199
  }
1077
1200
 
1078
1201
  export interface SignUpUser {
@@ -1080,7 +1203,20 @@ export interface SignUpUser {
1080
1203
  info?: UserInfo;
1081
1204
  inviteToken?: string;
1082
1205
  password?: string;
1083
- userId?: UserId;
1206
+ userId?: string;
1207
+ }
1208
+
1209
+ /**
1210
+ * Individual ride timing within a series
1211
+ */
1212
+ export interface SingleRide {
1213
+ desiredStartTime?: string;
1214
+ returnTrip?: boolean;
1215
+ }
1216
+
1217
+ export interface SingleRideUpdate {
1218
+ desiredStartTime?: string;
1219
+ rideId?: string;
1084
1220
  }
1085
1221
 
1086
1222
  export interface StopImpersonatingUser {
@@ -1096,18 +1232,14 @@ export interface SubscriptionInfo extends TimedPermission {
1096
1232
  service?: Service;
1097
1233
  }
1098
1234
 
1099
- export interface TaxiFilter extends RideTypeSpecificFilter {
1235
+ export interface TaxiFilter extends DrivePermissionFilter {
1100
1236
  allowedMobilities?: Mobility[];
1101
1237
  type: "taxi";
1102
1238
  }
1103
1239
 
1104
1240
  export interface Team {
1105
1241
  info?: TeamInfo;
1106
- teamId?: TeamId;
1107
- }
1108
-
1109
- export interface TeamId {
1110
- type?: Class<Team>;
1242
+ teamId?: string;
1111
1243
  }
1112
1244
 
1113
1245
  export interface TeamInfo {
@@ -1119,16 +1251,16 @@ export interface TeamInfo {
1119
1251
 
1120
1252
  export interface TeamPermission {
1121
1253
  roles?: TeamRole[];
1122
- teamId?: TeamId;
1254
+ teamId?: string;
1123
1255
  }
1124
1256
 
1125
1257
  export interface TeamUpdate extends AccountUpdate {
1126
- teamId?: TeamId;
1258
+ teamId?: string;
1127
1259
  }
1128
1260
 
1129
1261
  export interface TimeRange {
1130
- end?: Date;
1131
- start?: Date;
1262
+ end?: string;
1263
+ start?: string;
1132
1264
  }
1133
1265
 
1134
1266
  export interface TimedPermission {
@@ -1141,15 +1273,11 @@ export interface Token {
1141
1273
  info?: TokenInfo;
1142
1274
  lastUpdatedBy?: string;
1143
1275
  revoked?: boolean;
1144
- tokenId?: TokenId;
1276
+ tokenId?: string;
1145
1277
  }
1146
1278
 
1147
1279
  export interface TokenCommand {
1148
- tokenId?: TokenId;
1149
- }
1150
-
1151
- export interface TokenId extends UserOrTokenId {
1152
- type?: Class<Token>;
1280
+ tokenId?: string;
1153
1281
  }
1154
1282
 
1155
1283
  export interface TokenInfo {
@@ -1161,20 +1289,6 @@ export interface TokenInfo {
1161
1289
  export interface TokenUpdate extends TokenCommand {
1162
1290
  }
1163
1291
 
1164
- export interface Type {
1165
- typeName?: string;
1166
- }
1167
-
1168
- export interface TypeDescriptor {
1169
- }
1170
-
1171
- export interface TypeVariable<D> extends Type, AnnotatedElement {
1172
- annotatedBounds?: AnnotatedType[];
1173
- bounds?: Type[];
1174
- genericDeclaration?: D;
1175
- name?: string;
1176
- }
1177
-
1178
1292
  export interface UpdateAccountInfo extends AccountUpdate {
1179
1293
  autoConfirm?: boolean;
1180
1294
  criticalInfo?: CriticalAccountInfo;
@@ -1185,9 +1299,18 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1185
1299
  accountPermission?: AccountPermission;
1186
1300
  }
1187
1301
 
1188
- export interface UpdateRideBooking extends RidePlannerCommand {
1302
+ export interface UpdateRide extends RideBookerCommand {
1303
+ booker?: AccountOrTeamRef;
1189
1304
  info?: RideInfo;
1190
- owner?: AccountOrTeamRef;
1305
+ }
1306
+
1307
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1308
+ plannedStartTime?: string;
1309
+ }
1310
+
1311
+ export interface UpdateRideSeries extends RideBookerSeriesCommand {
1312
+ info?: GenericRideInfo;
1313
+ rides?: SingleRide[];
1191
1314
  }
1192
1315
 
1193
1316
  export interface UpdateTeam extends TeamUpdate {
@@ -1203,15 +1326,14 @@ export interface UpdateUserInfo extends UserEdit {
1203
1326
  info?: UserInfo;
1204
1327
  }
1205
1328
 
1206
- export interface UserCommand {
1207
- userId?: UserId;
1329
+ export interface UserAndTokenUpcaster {
1208
1330
  }
1209
1331
 
1210
- export interface UserEdit extends UserUpdateAfterSignup {
1332
+ export interface UserCommand {
1333
+ userId?: string;
1211
1334
  }
1212
1335
 
1213
- export interface UserId extends UserOrTokenId {
1214
- type?: Class<UserProfile>;
1336
+ export interface UserEdit extends UserUpdateAfterSignup {
1215
1337
  }
1216
1338
 
1217
1339
  export interface UserInfo {
@@ -1232,7 +1354,7 @@ export interface UserProfile {
1232
1354
  email?: string;
1233
1355
  emailConfirmed?: boolean;
1234
1356
  info?: UserInfo;
1235
- userId?: UserId;
1357
+ userId?: string;
1236
1358
  userRole?: UserRole;
1237
1359
  }
1238
1360
 
@@ -1242,21 +1364,18 @@ export interface UserUpdate extends UserCommand {
1242
1364
  export interface UserUpdateAfterSignup extends UserUpdate {
1243
1365
  }
1244
1366
 
1245
- export interface ZoneId extends Serializable {
1246
- }
1247
-
1248
1367
  export interface ZonedTimeRange {
1249
1368
  end?: Date;
1250
1369
  start?: Date;
1251
1370
  }
1252
1371
 
1253
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1372
+ export type AccountRole = "ridebooker" | "dispatcher" | "admin" | "owner";
1254
1373
 
1255
1374
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1256
1375
 
1257
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1376
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1258
1377
 
1259
- export type Direction = "admission" | "relocation" | "discharge" | "consultation";
1378
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1260
1379
 
1261
1380
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1262
1381
 
@@ -1266,20 +1385,24 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
1266
1385
 
1267
1386
  export type IntegrationType = "dispolive" | "celios";
1268
1387
 
1269
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1388
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1389
+
1390
+ export type OrganisationType = "medical" | "fleet";
1270
1391
 
1271
- export type RideType = "taxi" | "ambulance";
1392
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1272
1393
 
1273
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1394
+ export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
1274
1395
 
1275
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1396
+ export type Service = "pro_medical" | "pro_fleet" | "celios_integration" | "dispolive_integration";
1276
1397
 
1277
1398
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1278
1399
 
1279
- export type StandaloneService = "rideplanning" | "driveplanning";
1400
+ export type StandaloneService = "pro_medical" | "pro_fleet";
1280
1401
 
1281
1402
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1282
1403
 
1283
- export type TeamRole = "driveplanner" | "rideplanner";
1404
+ export type TeamRole = "dispatcher" | "ridebooker";
1284
1405
 
1285
1406
  export type UserRole = "superadmin";
1407
+
1408
+ 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.1151-test-server",
3
+ "version": "0.1.1161-test-server",
4
4
  "types": "common.d.ts"
5
5
  }