@moxi.gmbh/moxi-typescriptmodels 0.1.1061-test-server → 0.1.1081-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 +424 -247
  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,19 @@ export interface AmbulanceInfo {
133
136
  requiresSuctionAspirator?: boolean;
134
137
  }
135
138
 
136
- export interface AnnotatedElement {
137
- annotations?: Annotation[];
138
- declaredAnnotations?: Annotation[];
139
- }
140
-
141
- export interface AnnotatedType extends AnnotatedElement {
142
- annotatedOwnerType?: AnnotatedType;
143
- type?: Type;
144
- }
145
-
146
- export interface Annotation {
139
+ /**
140
+ * Same as RideInfo, except it does not contain an appointment
141
+ */
142
+ export interface AnonymizedRideInfo extends GenericRideInfo {
147
143
  }
148
144
 
149
145
  export interface Appointment {
150
146
  pickup?: boolean;
151
- time?: Date;
147
+ time?: string;
152
148
  }
153
149
 
154
150
  export interface AssignDriver extends RideCommand {
155
- driveOwner?: AccountOrTeamRef;
151
+ driver?: AccountOrTeamRef;
156
152
  }
157
153
 
158
154
  export interface Attachment {
@@ -167,27 +163,47 @@ export interface AuthenticateWithToken extends UserUpdate {
167
163
 
168
164
  export interface AuthenticationResponse {
169
165
  authorizationHeader?: string;
170
- impersonator?: UserId;
166
+ impersonator?: string;
171
167
  result?: AuthenticationResult;
172
- sessionDeadline?: Date;
168
+ sessionDeadline?: string;
173
169
  userProfile?: UserProfile;
174
170
  }
175
171
 
176
172
  export interface AuthenticationService {
177
173
  }
178
174
 
175
+ export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
176
+ info?: GenericRideInfo;
177
+ updater?: AccountOrTeamRef;
178
+ }
179
+
180
+ export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
181
+ rides?: SingleRideUpdate[];
182
+ updater?: AccountOrTeamRef;
183
+ }
184
+
179
185
  export interface BookRide extends CreateRideCommand {
186
+ booker?: AccountOrTeamRef;
180
187
  info?: RideInfo;
181
- owner?: AccountOrTeamRef;
182
188
  }
183
189
 
184
- export interface CancelDrive extends FleetModifyCommand {
190
+ export interface BookRideSeries extends RideBookerSeriesCommand {
191
+ booker?: AccountOrTeamRef;
192
+ info?: GenericRideInfo;
193
+ rides?: SingleRide[];
185
194
  }
186
195
 
187
- export interface CancelRide extends RidePlannerCommand {
196
+ export interface CancelRide extends RideBookerCommand {
188
197
  reason?: string;
189
198
  }
190
199
 
200
+ export interface CancelRideSeries extends RideBookerSeriesCommand {
201
+ }
202
+
203
+ export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
204
+ updater?: AccountOrTeamRef;
205
+ }
206
+
191
207
  export interface CeliosSettings {
192
208
  certificate?: string;
193
209
  host?: string;
@@ -200,17 +216,11 @@ export interface CeliosSettings {
200
216
  export interface ChangeUserPassword {
201
217
  newPassword?: string;
202
218
  oldPassword?: string;
203
- userId?: UserId;
219
+ userId?: string;
204
220
  }
205
221
 
206
222
  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 {
223
+ userId?: string;
214
224
  }
215
225
 
216
226
  export interface ConfirmAccount extends AccountCommand {
@@ -223,13 +233,16 @@ export interface ConfirmDrivePermission extends AccountUpdate {
223
233
  export interface ConfirmEverythingInAccount extends AccountCommand {
224
234
  }
225
235
 
236
+ export interface ConfirmRideSeries extends RideDriverSeriesCommand {
237
+ }
238
+
226
239
  export interface ConfirmSubscription extends AccountUpdate {
227
240
  subscriptionId?: string;
228
241
  }
229
242
 
230
243
  export interface ConfirmUser {
231
244
  token?: string;
232
- userId?: UserId;
245
+ userId?: string;
233
246
  }
234
247
 
235
248
  export interface ConfirmablePermission {
@@ -237,14 +250,11 @@ export interface ConfirmablePermission {
237
250
  revoked?: boolean;
238
251
  }
239
252
 
240
- export interface Constable {
241
- }
242
-
243
253
  export interface CreateAccount extends AccountCommand {
244
254
  autoConfirm?: boolean;
245
255
  criticalInfo?: CriticalAccountInfo;
246
256
  info?: AccountInfo;
247
- owner?: UserId;
257
+ owner?: string;
248
258
  requestService?: StandaloneService;
249
259
  }
250
260
 
@@ -253,8 +263,16 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
253
263
  timeRange?: InstantRange;
254
264
  }
255
265
 
256
- export interface CreateRideCommand extends RidePlannerCommand {
257
- owner?: AccountOrTeamId;
266
+ export interface CreateRideCommand extends RideBookerCommand {
267
+ booker?: AccountOrTeamId;
268
+ }
269
+
270
+ export interface CreateRideFromSeries extends RideDriverCommand {
271
+ booker?: AccountOrTeamRef;
272
+ driver?: AccountOrTeamRef;
273
+ info?: RideInfo;
274
+ returnTrip?: boolean;
275
+ rideSeriesId?: string;
258
276
  }
259
277
 
260
278
  export interface CreateSqueezeInPlan extends OptimizerMessage {
@@ -263,7 +281,7 @@ export interface CreateSqueezeInPlan extends OptimizerMessage {
263
281
 
264
282
  export interface CreateTeam extends AccountCommand {
265
283
  info?: TeamInfo;
266
- teamId?: TeamId;
284
+ teamId?: string;
267
285
  }
268
286
 
269
287
  export interface CreateToken extends TokenCommand {
@@ -283,19 +301,16 @@ export interface CriticalAccountInfo {
283
301
  }
284
302
 
285
303
  export interface DateRange {
286
- end?: Date;
287
- start?: Date;
304
+ end?: string;
305
+ start?: string;
288
306
  }
289
307
 
290
308
  export interface DeleteUser extends UserEdit {
291
309
  }
292
310
 
293
- export interface Dimension extends Dimension2D, Serializable {
294
- }
295
-
296
- export interface Dimension2D extends Cloneable {
297
- height?: number;
298
- width?: number;
311
+ export interface DisconnectClient {
312
+ clientId?: string;
313
+ tokenId?: string;
299
314
  }
300
315
 
301
316
  export interface DispoliveSettings {
@@ -306,7 +321,7 @@ export interface DispoliveSettings {
306
321
 
307
322
  export interface District {
308
323
  info?: DistrictInfo;
309
- polygons?: Polygon[];
324
+ polygons?: any[];
310
325
  }
311
326
 
312
327
  export interface DistrictInfo {
@@ -330,14 +345,18 @@ export interface DrivePermission {
330
345
  revoked?: boolean;
331
346
  }
332
347
 
348
+ export interface DrivePermissionFilter {
349
+ type: "ambulance" | "taxi";
350
+ }
351
+
333
352
  export interface DrivePermissionInfo {
334
- filter?: RideTypeSpecificFilterUnion;
353
+ filter?: DrivePermissionFilterUnion;
335
354
  monopoly?: boolean;
336
355
  regions?: Region[];
337
356
  }
338
357
 
339
358
  export interface DrivePermissionInfoRequest {
340
- filter?: RideTypeSpecificFilterUnion;
359
+ filter?: DrivePermissionFilterUnion;
341
360
  regions?: Region[];
342
361
  }
343
362
 
@@ -377,7 +396,7 @@ export interface FetchGoogleGeoLocation {
377
396
  }
378
397
 
379
398
  export interface FetchGoogleRoute {
380
- departureTime?: Date;
399
+ departureTime?: string;
381
400
  from?: GeoLocation;
382
401
  to?: GeoLocation;
383
402
  }
@@ -400,7 +419,7 @@ export interface FindAccounts {
400
419
  }
401
420
 
402
421
  export interface FindMyAcceptedRides {
403
- accountId?: AccountId;
422
+ accountId?: string;
404
423
  descending?: boolean;
405
424
  filter?: RideFilter;
406
425
  maxSize?: number;
@@ -411,7 +430,15 @@ export interface FindMyAcceptedRides {
411
430
  * @deprecated
412
431
  */
413
432
  export interface FindMyRideOffers {
414
- accountId?: AccountId;
433
+ accountId?: string;
434
+ descending?: boolean;
435
+ filter?: RideFilter;
436
+ maxSize?: number;
437
+ term?: string;
438
+ }
439
+
440
+ export interface FindMyRideSeries {
441
+ accountId?: string;
415
442
  descending?: boolean;
416
443
  filter?: RideFilter;
417
444
  maxSize?: number;
@@ -419,7 +446,7 @@ export interface FindMyRideOffers {
419
446
  }
420
447
 
421
448
  export interface FindMyRides {
422
- accountId?: AccountId;
449
+ accountId?: string;
423
450
  descending?: boolean;
424
451
  filter?: RideFilter;
425
452
  maxSize?: number;
@@ -427,19 +454,27 @@ export interface FindMyRides {
427
454
  }
428
455
 
429
456
  export interface FindMyTokens {
430
- accountId?: AccountId;
431
- teamId?: TeamId;
457
+ accountId?: string;
458
+ teamId?: string;
432
459
  term?: string;
433
460
  }
434
461
 
435
462
  export interface FindMyUsers {
436
- accountId?: AccountId;
437
- teamId?: TeamId;
463
+ accountId?: string;
464
+ teamId?: string;
438
465
  term?: string;
439
466
  }
440
467
 
468
+ export interface FindPotentialRideSeries {
469
+ accountId?: string;
470
+ descending?: boolean;
471
+ filter?: RideInfoFilter;
472
+ maxSize?: number;
473
+ timeRange?: InstantRange;
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,34 @@ 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
+ * Same as RideInfo, except it does not contain an appointment
512
+ */
513
+ export interface GenericRideInfo {
514
+ ambulanceInfo?: AmbulanceInfo;
515
+ attendantsPresent?: number;
516
+ comment?: string;
517
+ dimensions?: PersonDimensions;
518
+ distanceInMeters?: number;
519
+ from?: AddressInfo;
520
+ /**
521
+ * Derived from weightInKg != null
522
+ */
523
+ heavyWeight?: boolean;
524
+ mobility?: Mobility;
525
+ patient?: Person;
526
+ plannedDuration?: RideDuration;
527
+ preferredDriver?: string;
528
+ purpose?: RidePurpose;
529
+ to?: AddressInfo;
530
+ vehicleType?: VehicleType;
531
+ weightInKg?: number;
483
532
  }
484
533
 
485
534
  export interface GeoJson {
@@ -509,7 +558,7 @@ export interface Geometry {
509
558
  }
510
559
 
511
560
  export interface GetAccount {
512
- accountId?: AccountId;
561
+ accountId?: string;
513
562
  }
514
563
 
515
564
  export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
@@ -539,7 +588,7 @@ export interface GetMonopolyAccounts {
539
588
  }
540
589
 
541
590
  export interface GetMyAcceptedRides {
542
- accountId?: AccountId;
591
+ accountId?: string;
543
592
  maxSize?: number;
544
593
  timeRange?: InstantRange;
545
594
  }
@@ -552,13 +601,19 @@ export interface GetMyAccounts {
552
601
  * @deprecated
553
602
  */
554
603
  export interface GetMyRideOffers {
555
- accountId?: AccountId;
604
+ accountId?: string;
605
+ maxSize?: number;
606
+ timeRange?: InstantRange;
607
+ }
608
+
609
+ export interface GetMyRideSeries {
610
+ accountId?: string;
556
611
  maxSize?: number;
557
612
  timeRange?: InstantRange;
558
613
  }
559
614
 
560
615
  export interface GetMyRides {
561
- accountId?: AccountId;
616
+ accountId?: string;
562
617
  maxSize?: number;
563
618
  timeRange?: InstantRange;
564
619
  }
@@ -575,42 +630,55 @@ export interface GetNutsStates {
575
630
  export interface GetPotentialDrivers {
576
631
  fromDistrict?: string;
577
632
  mobility?: Mobility;
578
- rideType?: RideType;
579
633
  toDistrict?: string;
634
+ vehicleType?: VehicleType;
580
635
  weightInKg?: number;
581
636
  }
582
637
 
583
638
  export interface GetPotentialRides {
584
- accountId?: AccountId;
639
+ accountId?: string;
585
640
  maxSize?: number;
586
641
  timeRange?: InstantRange;
587
642
  }
588
643
 
589
644
  export interface GetRide {
590
- rideId?: RideId;
645
+ rideId?: string;
591
646
  }
592
647
 
593
648
  export interface GetRideCsv extends RideStatisticsQuery {
594
649
  }
595
650
 
596
- export interface GetRideData extends RideStatisticsQuery {
597
- rideOwner?: AccountId;
651
+ export interface GetRideDataForBooker extends RideStatisticsQuery {
652
+ accountId?: string;
653
+ }
654
+
655
+ export interface GetRideDataForDriver extends RideStatisticsQuery {
656
+ accountId?: string;
598
657
  }
599
658
 
600
659
  export interface GetRideLog {
601
- rideId?: RideId;
660
+ rideId?: string;
661
+ }
662
+
663
+ export interface GetRideSeries {
664
+ rideSeriesId?: string;
665
+ }
666
+
667
+ export interface GetRidesInSeries {
668
+ filter?: RideFilter;
669
+ rideSeriesId?: string;
602
670
  }
603
671
 
604
672
  export interface GetTeam {
605
- teamId?: TeamId;
673
+ teamId?: string;
606
674
  }
607
675
 
608
676
  export interface GetToken {
609
- tokenId?: TokenId;
677
+ tokenId?: string;
610
678
  }
611
679
 
612
680
  export interface GetUserProfile {
613
- userId?: UserId;
681
+ userId?: string;
614
682
  }
615
683
 
616
684
  export interface GiveDrivePermission extends AccountUpdate {
@@ -628,15 +696,12 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
628
696
  }
629
697
 
630
698
  export interface ImpersonateUser {
631
- userId?: UserId;
632
- }
633
-
634
- export interface InetAddress extends Serializable {
699
+ userId?: string;
635
700
  }
636
701
 
637
702
  export interface InstantRange {
638
- end?: Date;
639
- start?: Date;
703
+ end?: string;
704
+ start?: string;
640
705
  }
641
706
 
642
707
  export interface Insurer {
@@ -645,7 +710,7 @@ export interface Insurer {
645
710
  }
646
711
 
647
712
  export interface Invite {
648
- accountId?: AccountId;
713
+ accountId?: string;
649
714
  invitedBy?: string;
650
715
  }
651
716
 
@@ -659,7 +724,7 @@ export interface InviteUser extends UserCommand {
659
724
  * Ip4 or ip6 range in CIDR format
660
725
  */
661
726
  export interface IpRange {
662
- ip?: InetAddress;
727
+ ip?: string;
663
728
  range?: number;
664
729
  }
665
730
 
@@ -670,6 +735,16 @@ export interface IsoState {
670
735
  nutsCode?: string;
671
736
  }
672
737
 
738
+ export interface Metric {
739
+ clientId?: string;
740
+ clientSegment?: number[];
741
+ maxSize?: number;
742
+ maxTimeout?: string;
743
+ tokenId?: string;
744
+ type?: string;
745
+ updates?: string[];
746
+ }
747
+
673
748
  export interface NutsDistrict {
674
749
  code?: string;
675
750
  name?: string;
@@ -687,11 +762,6 @@ export interface NutsSubState {
687
762
  name?: string;
688
763
  }
689
764
 
690
- export interface OfField<F> extends TypeDescriptor {
691
- array?: boolean;
692
- primitive?: boolean;
693
- }
694
-
695
765
  export interface OffsetTimeRange {
696
766
  end?: Date;
697
767
  start?: Date;
@@ -702,7 +772,7 @@ export interface OptimizerMessage {
702
772
 
703
773
  export interface Person {
704
774
  address?: AddressInfo;
705
- birthDay?: Date;
775
+ birthDay?: string;
706
776
  email?: string;
707
777
  firstName?: string;
708
778
  insuranceNumber?: string;
@@ -724,45 +794,44 @@ export interface PersonDimensions {
724
794
  export interface PhoneNumber {
725
795
  }
726
796
 
727
- export interface Point extends Point2D, Serializable {
728
- }
729
-
730
- export interface Point2D extends Cloneable {
731
- x?: number;
732
- y?: number;
797
+ export interface PlanRide extends RideDriverModifyCommand {
798
+ plannedStartTime?: string;
733
799
  }
734
800
 
735
- export interface Polygon extends Shape, Serializable {
801
+ export interface ReadUpdateResult<T> {
802
+ after?: T;
803
+ before?: T;
736
804
  /**
737
- * @deprecated
805
+ * The id of the entity that the update is about
738
806
  */
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;
807
+ entityId?: string;
808
+ /**
809
+ * The type/name of the event that caused this update
810
+ */
811
+ eventType?: string;
812
+ /**
813
+ * Index of this update
814
+ */
815
+ index?: number;
816
+ /**
817
+ * Time at which this update occurred
818
+ */
819
+ timestamp?: string;
820
+ type: "rideseries" | "ride";
749
821
  }
750
822
 
751
- export interface Rectangle2D extends RectangularShape {
823
+ export interface ReadUpdates {
824
+ clientId?: string;
825
+ maxSize?: number;
826
+ maxTimeout?: number;
827
+ tokenId?: string;
828
+ updateTypes?: TrackingUpdateType[];
752
829
  }
753
830
 
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;
831
+ export interface ReadUpdatesResult {
832
+ clientSegment?: number[];
833
+ lastIndex?: number;
834
+ updates?: ReadUpdateResultUnion<any>[];
766
835
  }
767
836
 
768
837
  export interface Region {
@@ -773,21 +842,16 @@ export interface RegisterAuthenticationToken extends UserUpdate {
773
842
  hashedToken?: string;
774
843
  }
775
844
 
776
- export interface RegisterDifferentEta extends FleetModifyCommand {
777
- destinationEta?: Date;
778
- originEta?: Date;
779
- }
780
-
781
- export interface RegisterDriveStatus extends FleetModifyCommand {
845
+ export interface RegisterDriveStatus extends RideDriverModifyCommand {
782
846
  driveStatus?: DriveStatus;
783
847
  }
784
848
 
785
- export interface RegisterDriverSynced extends FleetModifyCommand {
849
+ export interface RegisterDriverSynced extends RideDriverModifyCommand {
786
850
  }
787
851
 
788
852
  export interface RegisterEinsatz {
789
853
  einsatzNumber?: string;
790
- rideId?: RideId;
854
+ rideId?: string;
791
855
  }
792
856
 
793
857
  export interface RemoveAccount extends AccountUpdate {
@@ -801,7 +865,7 @@ export interface RemoveTeam extends TeamUpdate {
801
865
  }
802
866
 
803
867
  export interface RemoveTeamPermission extends AccountPermissionCommand {
804
- teamId?: TeamId;
868
+ teamId?: string;
805
869
  }
806
870
 
807
871
  export interface ReportIssue {
@@ -809,6 +873,13 @@ export interface ReportIssue {
809
873
  issue?: string;
810
874
  }
811
875
 
876
+ /**
877
+ * Can only report delays when ride has started and has not arrived at destination.
878
+ */
879
+ export interface ReportRideDelay extends RideDriverModifyCommand {
880
+ minutes?: number;
881
+ }
882
+
812
883
  export interface RequestDrivePermission extends AccountUpdate {
813
884
  drivePermissionId?: string;
814
885
  info?: DrivePermissionInfoRequest;
@@ -823,16 +894,31 @@ export interface RequestUserReset {
823
894
  email?: string;
824
895
  }
825
896
 
897
+ /**
898
+ * Resets the lastIndex position of your token.
899
+ */
900
+ export interface ResetPosition {
901
+ index?: number;
902
+ timestamp?: string;
903
+ tokenId?: string;
904
+ }
905
+
906
+ export interface ReturnRide extends RideDriverModifyCommand {
907
+ }
908
+
909
+ export interface ReturnRideSeries extends RideDriverSeriesCommand {
910
+ }
911
+
826
912
  export interface Review {
827
913
  comment?: string;
828
914
  stars?: number;
829
915
  }
830
916
 
831
- export interface ReviewRideAsDriver extends FleetModifyCommand {
917
+ export interface ReviewRideAsBooker extends RideBookerCommand {
832
918
  review?: Review;
833
919
  }
834
920
 
835
- export interface ReviewRideAsRider extends RidePlannerCommand {
921
+ export interface ReviewRideAsDriver extends RideDriverModifyCommand {
836
922
  review?: Review;
837
923
  }
838
924
 
@@ -852,14 +938,22 @@ export interface RevokeToken extends TokenUpdate {
852
938
 
853
939
  export interface Ride {
854
940
  /**
855
- * Derived from driveOwner != null
941
+ * Derived from driver != null
856
942
  */
857
943
  accepted?: boolean;
944
+ actualEndTime?: string;
945
+ actualStartTime?: string;
946
+ /**
947
+ * Derived from driveStatus != null
948
+ */
949
+ arrived?: boolean;
858
950
  /**
859
951
  * Derived from bookedTime != null
860
952
  */
861
953
  booked?: boolean;
862
- bookedTime?: Date;
954
+ bookedTime?: string;
955
+ booker?: AccountOrTeamRef;
956
+ bookerReview?: Review;
863
957
  bookingStatus?: BookingStatus;
864
958
  cancelReason?: string;
865
959
  cancelled?: boolean;
@@ -868,37 +962,71 @@ export interface Ride {
868
962
  */
869
963
  completed?: boolean;
870
964
  /**
871
- * Estimated Time of Arrival at the Destination/Drop-off location. Will differ from destinationPta if the driver reported a delay
965
+ * Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
872
966
  */
873
- destinationEta?: Date;
967
+ desiredEndTime?: string;
874
968
  /**
875
- * Planned Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
969
+ * Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
876
970
  */
877
- destinationPta?: Date;
878
- driveOwner?: AccountOrTeamRef;
971
+ desiredStartTime?: string;
972
+ /**
973
+ * Display time is the planned time, or else the desired time
974
+ */
975
+ displayEndTime?: string;
976
+ /**
977
+ * Display time is the planned time, or else the desired time
978
+ */
979
+ displayStartTime?: string;
879
980
  driveStatus?: DriveStatus;
981
+ driver?: AccountOrTeamRef;
880
982
  driverReview?: Review;
881
983
  driverSyncStatus?: SyncStatus;
984
+ endTimeDelay?: number;
985
+ /**
986
+ * Expected Time of Arrival at the Destination/Drop-off location.
987
+ */
988
+ expectedEndTime?: string;
989
+ /**
990
+ * Expected Time of Arrival at the Origin/Pick-up location.
991
+ */
992
+ expectedStartTime?: string;
882
993
  info?: RideInfo;
883
994
  /**
884
- * Estimated Time of Arrival at the Origin/Pick-up location. Will differ from originPta if the driver reported a delay
995
+ * Derived from plannedStartTime != null
885
996
  */
886
- originEta?: Date;
997
+ planned?: boolean;
887
998
  /**
888
- * Planned Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
999
+ * Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
889
1000
  */
890
- originPta?: Date;
891
- rideId?: RideId;
892
- rideOwner?: AccountOrTeamRef;
893
- riderReview?: Review;
1001
+ plannedEndTime?: string;
1002
+ plannedStartTime?: string;
1003
+ returnTrip?: boolean;
1004
+ rideId?: string;
1005
+ rideSeriesId?: string;
1006
+ startTimeDelay?: number;
894
1007
  /**
895
1008
  * Derived from driveStatus != null
896
1009
  */
897
1010
  started?: boolean;
898
1011
  }
899
1012
 
1013
+ export interface RideBookerCommand extends RideCommand {
1014
+ }
1015
+
1016
+ export interface RideBookerSeriesCommand extends RideSeriesCommand {
1017
+ }
1018
+
900
1019
  export interface RideCommand {
901
- rideId?: RideId;
1020
+ rideId?: string;
1021
+ }
1022
+
1023
+ export interface RideDriverCommand extends RideCommand {
1024
+ }
1025
+
1026
+ export interface RideDriverModifyCommand extends RideDriverCommand {
1027
+ }
1028
+
1029
+ export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
902
1030
  }
903
1031
 
904
1032
  /**
@@ -913,47 +1041,43 @@ export interface RideDuration {
913
1041
 
914
1042
  export interface RideFilter {
915
1043
  bookingStatuses?: BookingStatus[];
916
- directions?: Direction[];
917
1044
  driveStatuses?: DriveStatus[];
918
1045
  driverAccountNames?: string[];
919
1046
  driverTeamNames?: string[];
920
1047
  hasInfection?: boolean;
921
1048
  heavyWeight?: boolean;
922
1049
  mobilities?: Mobility[];
1050
+ purposes?: RidePurpose[];
923
1051
  region?: Region;
924
1052
  requiresMonitoring?: boolean;
925
1053
  requiresOxygen?: boolean;
926
1054
  requiresSuctionAspirator?: boolean;
927
- rideType?: RideType;
928
1055
  riderAccountNames?: string[];
929
1056
  riderTeamNames?: string[];
930
1057
  timeRange?: InstantRange;
1058
+ vehicleType?: VehicleType;
931
1059
  }
932
1060
 
933
1061
  export interface RideFilterCount {
934
1062
  bookingStatuses?: { [P in BookingStatus]?: number };
935
- directions?: { [P in Direction]?: number };
936
1063
  driveStatuses?: { [P in DriveStatus]?: number };
937
1064
  driverAccountNames?: { [index: string]: number };
938
1065
  driverTeamNames?: { [index: string]: number };
939
1066
  hasInfection?: number;
940
1067
  heavyWeight?: number;
941
1068
  mobilities?: { [P in Mobility]?: number };
1069
+ purposes?: { [P in RidePurpose]?: number };
942
1070
  requiresMonitoring?: number;
943
1071
  requiresOxygen?: number;
944
1072
  requiresSuctionAspirator?: number;
945
- rideTypes?: { [P in RideType]?: number };
946
1073
  riderAccountNames?: { [index: string]: number };
947
1074
  riderTeamNames?: { [index: string]: number };
948
1075
  total?: number;
949
- }
950
-
951
- export interface RideId {
952
- type?: Class<Ride>;
1076
+ vehicleTypes?: { [P in VehicleType]?: number };
953
1077
  }
954
1078
 
955
1079
  export interface RideIdResult {
956
- rideId?: RideId;
1080
+ rideId?: string;
957
1081
  }
958
1082
 
959
1083
  /**
@@ -965,7 +1089,6 @@ export interface RideInfo {
965
1089
  attendantsPresent?: number;
966
1090
  comment?: string;
967
1091
  dimensions?: PersonDimensions;
968
- direction?: Direction;
969
1092
  distanceInMeters?: number;
970
1093
  from?: AddressInfo;
971
1094
  /**
@@ -975,12 +1098,25 @@ export interface RideInfo {
975
1098
  mobility?: Mobility;
976
1099
  patient?: Person;
977
1100
  plannedDuration?: RideDuration;
978
- preferredDriver?: AccountId;
979
- rideType?: RideType;
1101
+ preferredDriver?: string;
1102
+ purpose?: RidePurpose;
980
1103
  to?: AddressInfo;
1104
+ vehicleType?: VehicleType;
981
1105
  weightInKg?: number;
982
1106
  }
983
1107
 
1108
+ export interface RideInfoFilter {
1109
+ hasInfection?: boolean;
1110
+ heavyWeight?: boolean;
1111
+ mobilities?: Mobility[];
1112
+ purposes?: RidePurpose[];
1113
+ region?: Region;
1114
+ requiresMonitoring?: boolean;
1115
+ requiresOxygen?: boolean;
1116
+ requiresSuctionAspirator?: boolean;
1117
+ vehicleType?: VehicleType;
1118
+ }
1119
+
984
1120
  export interface RideLog {
985
1121
  actingFor?: AccountOrTeamRef;
986
1122
  allowedViewers?: AccountOrTeamRef[];
@@ -993,7 +1129,7 @@ export interface RideLog {
993
1129
  isSuperAdmin?: boolean;
994
1130
  isToken?: boolean;
995
1131
  superAdmin?: boolean;
996
- timestamp?: Date;
1132
+ timestamp?: string;
997
1133
  token?: boolean;
998
1134
  }
999
1135
 
@@ -1001,17 +1137,59 @@ export interface RideOfferInfo {
1001
1137
  appointment?: Appointment;
1002
1138
  }
1003
1139
 
1004
- export interface RidePlannerCommand extends RideCommand {
1140
+ export interface RideSeries {
1141
+ accepted?: boolean;
1142
+ booked?: boolean;
1143
+ booker?: AccountOrTeamRef;
1144
+ cancelled?: boolean;
1145
+ confirmed?: boolean;
1146
+ driver?: AccountOrTeamRef;
1147
+ endTime?: string;
1148
+ info?: GenericRideInfo;
1149
+ rideSeriesId?: string;
1150
+ rides?: SingleRide[];
1151
+ startTime?: string;
1152
+ status?: RideSeriesStatus;
1153
+ }
1154
+
1155
+ export interface RideSeriesCommand {
1156
+ rideSeriesId?: string;
1157
+ }
1158
+
1159
+ export interface RideSeriesIdResult {
1160
+ rideSeriesId?: string;
1161
+ }
1162
+
1163
+ export interface RideSeriesPostConfirmCommand {
1164
+ rideSeriesId?: string;
1165
+ ridesToModify?: Ride[];
1166
+ }
1167
+
1168
+ export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
1169
+ }
1170
+
1171
+ export interface RideSeriesUpdate extends ReadUpdateResultUnion<RideSeries> {
1172
+ after?: RideSeries;
1173
+ before?: RideSeries;
1174
+ type: "rideseries";
1005
1175
  }
1006
1176
 
1007
1177
  export interface RideStatisticsQuery {
1008
1178
  dateRange?: DateRange;
1009
- timezoneOrDefault?: ZoneId;
1010
- zoneId?: ZoneId;
1179
+ timezoneOrDefault?: string;
1180
+ zoneId?: string;
1011
1181
  }
1012
1182
 
1013
- export interface RideTypeSpecificFilter {
1014
- type: "ambulance" | "taxi";
1183
+ export interface RideSystemCommand extends RideCommand {
1184
+ }
1185
+
1186
+ export interface RideUpcaster {
1187
+ }
1188
+
1189
+ export interface RideUpdate extends ReadUpdateResultUnion<Ride> {
1190
+ after?: Ride;
1191
+ before?: Ride;
1192
+ type: "ride";
1015
1193
  }
1016
1194
 
1017
1195
  export interface Role<T> {
@@ -1021,12 +1199,12 @@ export interface Role<T> {
1021
1199
  * Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
1022
1200
  */
1023
1201
  export interface SaveRide extends CreateRideCommand {
1202
+ booker?: AccountOrTeamRef;
1024
1203
  info?: RideInfo;
1025
- owner?: AccountOrTeamRef;
1026
1204
  }
1027
1205
 
1028
1206
  export interface SendConfirmationEmail {
1029
- userId?: UserId;
1207
+ userId?: string;
1030
1208
  }
1031
1209
 
1032
1210
  export interface SendEmail {
@@ -1039,8 +1217,8 @@ export interface SendFreshdeskNewTicket {
1039
1217
  }
1040
1218
 
1041
1219
  export interface SendInvitationEmail {
1042
- accountIdOfInvite?: AccountId;
1043
- userId?: UserId;
1220
+ accountIdOfInvite?: string;
1221
+ userId?: string;
1044
1222
  }
1045
1223
 
1046
1224
  export interface SendSlack {
@@ -1048,9 +1226,6 @@ export interface SendSlack {
1048
1226
  message?: string;
1049
1227
  }
1050
1228
 
1051
- export interface Serializable {
1052
- }
1053
-
1054
1229
  export interface SetSettings extends AccountUpdate {
1055
1230
  settings?: any;
1056
1231
  }
@@ -1058,21 +1233,16 @@ export interface SetSettings extends AccountUpdate {
1058
1233
  export interface SetUserPassword {
1059
1234
  confirmationCode?: string;
1060
1235
  password?: string;
1061
- userId?: UserId;
1236
+ userId?: string;
1062
1237
  }
1063
1238
 
1064
1239
  export interface SetUserRole extends UserUpdate {
1065
1240
  role?: UserRole;
1066
1241
  }
1067
1242
 
1068
- export interface Shape {
1069
- bounds?: Rectangle;
1070
- bounds2D?: Rectangle2D;
1071
- }
1072
-
1073
1243
  export interface SignInUser {
1074
1244
  password?: string;
1075
- userId?: UserId;
1245
+ userId?: string;
1076
1246
  }
1077
1247
 
1078
1248
  export interface SignUpUser {
@@ -1080,7 +1250,17 @@ export interface SignUpUser {
1080
1250
  info?: UserInfo;
1081
1251
  inviteToken?: string;
1082
1252
  password?: string;
1083
- userId?: UserId;
1253
+ userId?: string;
1254
+ }
1255
+
1256
+ export interface SingleRide {
1257
+ desiredStartTime?: string;
1258
+ returnTrip?: boolean;
1259
+ }
1260
+
1261
+ export interface SingleRideUpdate {
1262
+ desiredStartTime?: string;
1263
+ rideId?: string;
1084
1264
  }
1085
1265
 
1086
1266
  export interface StopImpersonatingUser {
@@ -1096,18 +1276,14 @@ export interface SubscriptionInfo extends TimedPermission {
1096
1276
  service?: Service;
1097
1277
  }
1098
1278
 
1099
- export interface TaxiFilter extends RideTypeSpecificFilter {
1279
+ export interface TaxiFilter extends DrivePermissionFilter {
1100
1280
  allowedMobilities?: Mobility[];
1101
1281
  type: "taxi";
1102
1282
  }
1103
1283
 
1104
1284
  export interface Team {
1105
1285
  info?: TeamInfo;
1106
- teamId?: TeamId;
1107
- }
1108
-
1109
- export interface TeamId {
1110
- type?: Class<Team>;
1286
+ teamId?: string;
1111
1287
  }
1112
1288
 
1113
1289
  export interface TeamInfo {
@@ -1119,16 +1295,16 @@ export interface TeamInfo {
1119
1295
 
1120
1296
  export interface TeamPermission {
1121
1297
  roles?: TeamRole[];
1122
- teamId?: TeamId;
1298
+ teamId?: string;
1123
1299
  }
1124
1300
 
1125
1301
  export interface TeamUpdate extends AccountUpdate {
1126
- teamId?: TeamId;
1302
+ teamId?: string;
1127
1303
  }
1128
1304
 
1129
1305
  export interface TimeRange {
1130
- end?: Date;
1131
- start?: Date;
1306
+ end?: string;
1307
+ start?: string;
1132
1308
  }
1133
1309
 
1134
1310
  export interface TimedPermission {
@@ -1141,15 +1317,11 @@ export interface Token {
1141
1317
  info?: TokenInfo;
1142
1318
  lastUpdatedBy?: string;
1143
1319
  revoked?: boolean;
1144
- tokenId?: TokenId;
1320
+ tokenId?: string;
1145
1321
  }
1146
1322
 
1147
1323
  export interface TokenCommand {
1148
- tokenId?: TokenId;
1149
- }
1150
-
1151
- export interface TokenId extends UserOrTokenId {
1152
- type?: Class<Token>;
1324
+ tokenId?: string;
1153
1325
  }
1154
1326
 
1155
1327
  export interface TokenInfo {
@@ -1161,20 +1333,6 @@ export interface TokenInfo {
1161
1333
  export interface TokenUpdate extends TokenCommand {
1162
1334
  }
1163
1335
 
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
1336
  export interface UpdateAccountInfo extends AccountUpdate {
1179
1337
  autoConfirm?: boolean;
1180
1338
  criticalInfo?: CriticalAccountInfo;
@@ -1185,9 +1343,24 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
1185
1343
  accountPermission?: AccountPermission;
1186
1344
  }
1187
1345
 
1188
- export interface UpdateRideBooking extends RidePlannerCommand {
1346
+ export interface UpdatePosition {
1347
+ clientSegment?: number[];
1348
+ lastIndex?: number;
1349
+ tokenId?: string;
1350
+ }
1351
+
1352
+ export interface UpdateRide extends RideBookerCommand {
1353
+ booker?: AccountOrTeamRef;
1189
1354
  info?: RideInfo;
1190
- owner?: AccountOrTeamRef;
1355
+ }
1356
+
1357
+ export interface UpdateRidePlan extends RideDriverModifyCommand {
1358
+ plannedStartTime?: string;
1359
+ }
1360
+
1361
+ export interface UpdateRideSeries extends RideBookerSeriesCommand {
1362
+ info?: GenericRideInfo;
1363
+ rides?: SingleRide[];
1191
1364
  }
1192
1365
 
1193
1366
  export interface UpdateTeam extends TeamUpdate {
@@ -1203,15 +1376,14 @@ export interface UpdateUserInfo extends UserEdit {
1203
1376
  info?: UserInfo;
1204
1377
  }
1205
1378
 
1206
- export interface UserCommand {
1207
- userId?: UserId;
1379
+ export interface UserAndTokenUpcaster {
1208
1380
  }
1209
1381
 
1210
- export interface UserEdit extends UserUpdateAfterSignup {
1382
+ export interface UserCommand {
1383
+ userId?: string;
1211
1384
  }
1212
1385
 
1213
- export interface UserId extends UserOrTokenId {
1214
- type?: Class<UserProfile>;
1386
+ export interface UserEdit extends UserUpdateAfterSignup {
1215
1387
  }
1216
1388
 
1217
1389
  export interface UserInfo {
@@ -1232,7 +1404,7 @@ export interface UserProfile {
1232
1404
  email?: string;
1233
1405
  emailConfirmed?: boolean;
1234
1406
  info?: UserInfo;
1235
- userId?: UserId;
1407
+ userId?: string;
1236
1408
  userRole?: UserRole;
1237
1409
  }
1238
1410
 
@@ -1242,21 +1414,18 @@ export interface UserUpdate extends UserCommand {
1242
1414
  export interface UserUpdateAfterSignup extends UserUpdate {
1243
1415
  }
1244
1416
 
1245
- export interface ZoneId extends Serializable {
1246
- }
1247
-
1248
1417
  export interface ZonedTimeRange {
1249
1418
  end?: Date;
1250
1419
  start?: Date;
1251
1420
  }
1252
1421
 
1253
- export type AccountRole = "rideplanner" | "driveplanner" | "admin" | "owner";
1422
+ export type AccountRole = "ridebooker" | "dispatcher" | "admin" | "owner";
1254
1423
 
1255
1424
  export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
1256
1425
 
1257
- export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
1426
+ export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
1258
1427
 
1259
- export type Direction = "admission" | "relocation" | "discharge" | "consultation";
1428
+ export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
1260
1429
 
1261
1430
  export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
1262
1431
 
@@ -1266,20 +1435,28 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
1266
1435
 
1267
1436
  export type IntegrationType = "dispolive" | "celios";
1268
1437
 
1269
- export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "lying_down";
1438
+ export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
1439
+
1440
+ export type OrganisationType = "medical" | "fleet";
1270
1441
 
1271
- export type RideType = "taxi" | "ambulance";
1442
+ export type ReadUpdateResultUnion<T> = RideUpdate | RideSeriesUpdate;
1272
1443
 
1273
- export type RideTypeSpecificFilterUnion = AmbulanceFilter | TaxiFilter;
1444
+ export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
1274
1445
 
1275
- export type Service = "rideplanning" | "driveplanning" | "celios_integration" | "dispolive_integration";
1446
+ export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
1447
+
1448
+ export type Service = "pro_medical" | "pro_fleet" | "celios_integration" | "dispolive_integration";
1276
1449
 
1277
1450
  export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
1278
1451
 
1279
- export type StandaloneService = "rideplanning" | "driveplanning";
1452
+ export type StandaloneService = "pro_medical" | "pro_fleet";
1280
1453
 
1281
1454
  export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
1282
1455
 
1283
- export type TeamRole = "driveplanner" | "rideplanner";
1456
+ export type TeamRole = "dispatcher" | "ridebooker";
1457
+
1458
+ export type TrackingUpdateType = "ride" | "rideseries";
1284
1459
 
1285
1460
  export type UserRole = "superadmin";
1461
+
1462
+ 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.1061-test-server",
3
+ "version": "0.1.1081-test-server",
4
4
  "types": "common.d.ts"
5
5
  }