@moxi.gmbh/moxi-typescriptmodels 0.1.511-test-server → 0.1.511
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/common.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
|
|
2
|
-
export interface
|
|
3
|
-
|
|
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 {
|
|
@@ -9,6 +13,10 @@ export interface AcceptUserAgreement extends UserEdit {
|
|
|
9
13
|
|
|
10
14
|
export interface Account {
|
|
11
15
|
accountId?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Derived from subscriptions
|
|
18
|
+
*/
|
|
19
|
+
activeOrganisationTypes?: OrganisationType[];
|
|
12
20
|
/**
|
|
13
21
|
* Derived from subscriptions
|
|
14
22
|
*/
|
|
@@ -27,11 +35,16 @@ export interface AccountCommand {
|
|
|
27
35
|
accountId?: string;
|
|
28
36
|
}
|
|
29
37
|
|
|
38
|
+
export interface AccountFilter {
|
|
39
|
+
activeServices?: Service[];
|
|
40
|
+
}
|
|
41
|
+
|
|
30
42
|
export interface AccountInfo {
|
|
31
43
|
address?: AddressInfo;
|
|
32
44
|
defaultLanguage?: string;
|
|
33
45
|
notificationEmails?: string[];
|
|
34
46
|
phoneNumber?: PhoneNumber;
|
|
47
|
+
zoneId?: string;
|
|
35
48
|
}
|
|
36
49
|
|
|
37
50
|
export interface AccountOrTeamId {
|
|
@@ -59,6 +72,9 @@ export interface AccountRef {
|
|
|
59
72
|
name?: string;
|
|
60
73
|
}
|
|
61
74
|
|
|
75
|
+
export interface AccountUpcaster {
|
|
76
|
+
}
|
|
77
|
+
|
|
62
78
|
export interface AccountUpdate extends AccountCommand {
|
|
63
79
|
}
|
|
64
80
|
|
|
@@ -97,13 +113,13 @@ export interface AdminSetUserPassword {
|
|
|
97
113
|
userId?: string;
|
|
98
114
|
}
|
|
99
115
|
|
|
100
|
-
export interface AmbulanceFilter extends
|
|
116
|
+
export interface AmbulanceFilter extends DrivePermissionFilter {
|
|
101
117
|
heavyWeightAllowed?: boolean;
|
|
102
118
|
type: "ambulance";
|
|
103
119
|
}
|
|
104
120
|
|
|
105
121
|
/**
|
|
106
|
-
* Filled if (and only if)
|
|
122
|
+
* Filled if (and only if) vehicleType == ambulance
|
|
107
123
|
*/
|
|
108
124
|
export interface AmbulanceInfo {
|
|
109
125
|
/**
|
|
@@ -124,13 +140,26 @@ export interface AmbulanceInfo {
|
|
|
124
140
|
requiresSuctionAspirator?: boolean;
|
|
125
141
|
}
|
|
126
142
|
|
|
143
|
+
/**
|
|
144
|
+
* Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
|
|
145
|
+
|
|
146
|
+
*/
|
|
147
|
+
export interface AnonymizedGenericRideInfo extends GenericRideInfo {
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Information about the ride, from the creator of the ride
|
|
152
|
+
*/
|
|
153
|
+
export interface AnonymizedRideInfo extends RideInfo {
|
|
154
|
+
}
|
|
155
|
+
|
|
127
156
|
export interface Appointment {
|
|
128
157
|
pickup?: boolean;
|
|
129
158
|
time?: string;
|
|
130
159
|
}
|
|
131
160
|
|
|
132
161
|
export interface AssignDriver extends RideCommand {
|
|
133
|
-
|
|
162
|
+
driver?: AccountOrTeamRef;
|
|
134
163
|
}
|
|
135
164
|
|
|
136
165
|
export interface Attachment {
|
|
@@ -154,18 +183,38 @@ export interface AuthenticationResponse {
|
|
|
154
183
|
export interface AuthenticationService {
|
|
155
184
|
}
|
|
156
185
|
|
|
186
|
+
export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
|
|
187
|
+
info?: GenericRideInfo;
|
|
188
|
+
updater?: AccountOrTeamRef;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface BatchUpdateRideSeriesTimes extends RideSeriesPostConfirmCommand {
|
|
192
|
+
rides?: SingleRideUpdate[];
|
|
193
|
+
updater?: AccountOrTeamRef;
|
|
194
|
+
}
|
|
195
|
+
|
|
157
196
|
export interface BookRide extends CreateRideCommand {
|
|
197
|
+
booker?: AccountOrTeamRef;
|
|
158
198
|
info?: RideInfo;
|
|
159
|
-
owner?: AccountOrTeamRef;
|
|
160
199
|
}
|
|
161
200
|
|
|
162
|
-
export interface
|
|
201
|
+
export interface BookRideSeries extends RideBookerSeriesCommand {
|
|
202
|
+
booker?: AccountOrTeamRef;
|
|
203
|
+
info?: GenericRideInfo;
|
|
204
|
+
rides?: SingleRide[];
|
|
163
205
|
}
|
|
164
206
|
|
|
165
|
-
export interface CancelRide extends
|
|
207
|
+
export interface CancelRide extends RideBookerCommand {
|
|
166
208
|
reason?: string;
|
|
167
209
|
}
|
|
168
210
|
|
|
211
|
+
export interface CancelRideSeries extends RideBookerSeriesCommand {
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
export interface CancelRidesInSeries extends RideSeriesPostConfirmCommand {
|
|
215
|
+
updater?: AccountOrTeamRef;
|
|
216
|
+
}
|
|
217
|
+
|
|
169
218
|
export interface CeliosSettings {
|
|
170
219
|
certificate?: string;
|
|
171
220
|
host?: string;
|
|
@@ -217,8 +266,27 @@ export interface CreateAccount extends AccountCommand {
|
|
|
217
266
|
requestService?: StandaloneService;
|
|
218
267
|
}
|
|
219
268
|
|
|
220
|
-
export interface
|
|
221
|
-
|
|
269
|
+
export interface CreateOptimizationPlan extends OptimizerMessage {
|
|
270
|
+
accountOrTeam?: AccountOrTeamRef;
|
|
271
|
+
timeRange?: InstantRange;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
export interface CreateRideCommand extends RideBookerCommand {
|
|
275
|
+
booker?: AccountOrTeamId;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
export interface CreateRideFromSeries extends RideDriverCommand {
|
|
279
|
+
booker?: AccountOrTeamRef;
|
|
280
|
+
driver?: AccountOrTeamRef;
|
|
281
|
+
info?: RideInfo;
|
|
282
|
+
seriesInfo?: SeriesInfo;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
export interface CreateRidesFromSeries extends RideDriverSeriesCommand {
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
export interface CreateSqueezeInPlan extends OptimizerMessage {
|
|
289
|
+
accountOrTeam?: AccountOrTeamRef;
|
|
222
290
|
}
|
|
223
291
|
|
|
224
292
|
export interface CreateTeam extends AccountCommand {
|
|
@@ -250,6 +318,11 @@ export interface DateRange {
|
|
|
250
318
|
export interface DeleteUser extends UserEdit {
|
|
251
319
|
}
|
|
252
320
|
|
|
321
|
+
export interface DisconnectClient {
|
|
322
|
+
clientId?: string;
|
|
323
|
+
tokenId?: string;
|
|
324
|
+
}
|
|
325
|
+
|
|
253
326
|
export interface DispoliveSettings {
|
|
254
327
|
key?: string;
|
|
255
328
|
type: "dispolive";
|
|
@@ -282,14 +355,18 @@ export interface DrivePermission {
|
|
|
282
355
|
revoked?: boolean;
|
|
283
356
|
}
|
|
284
357
|
|
|
358
|
+
export interface DrivePermissionFilter {
|
|
359
|
+
type: "ambulance" | "taxi";
|
|
360
|
+
}
|
|
361
|
+
|
|
285
362
|
export interface DrivePermissionInfo {
|
|
286
|
-
filter?:
|
|
363
|
+
filter?: DrivePermissionFilterUnion;
|
|
287
364
|
monopoly?: boolean;
|
|
288
365
|
regions?: Region[];
|
|
289
366
|
}
|
|
290
367
|
|
|
291
368
|
export interface DrivePermissionInfoRequest {
|
|
292
|
-
filter?:
|
|
369
|
+
filter?: DrivePermissionFilterUnion;
|
|
293
370
|
regions?: Region[];
|
|
294
371
|
}
|
|
295
372
|
|
|
@@ -339,10 +416,32 @@ export interface FetchRouteResult {
|
|
|
339
416
|
duration?: number;
|
|
340
417
|
}
|
|
341
418
|
|
|
419
|
+
/**
|
|
420
|
+
* @deprecated
|
|
421
|
+
*/
|
|
342
422
|
export interface FindAccount {
|
|
343
423
|
term?: string;
|
|
344
424
|
}
|
|
345
425
|
|
|
426
|
+
export interface FindAccounts {
|
|
427
|
+
filter?: AccountFilter;
|
|
428
|
+
term?: string;
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
/**
|
|
432
|
+
* @deprecated
|
|
433
|
+
*/
|
|
434
|
+
export interface FindMyAcceptedRides {
|
|
435
|
+
accountId?: string;
|
|
436
|
+
descending?: boolean;
|
|
437
|
+
filter?: RideFilter;
|
|
438
|
+
maxSize?: number;
|
|
439
|
+
term?: string;
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* @deprecated
|
|
444
|
+
*/
|
|
346
445
|
export interface FindMyRideOffers {
|
|
347
446
|
accountId?: string;
|
|
348
447
|
descending?: boolean;
|
|
@@ -351,6 +450,14 @@ export interface FindMyRideOffers {
|
|
|
351
450
|
term?: string;
|
|
352
451
|
}
|
|
353
452
|
|
|
453
|
+
export interface FindMyRideSeries {
|
|
454
|
+
accountId?: string;
|
|
455
|
+
descending?: boolean;
|
|
456
|
+
maxSize?: number;
|
|
457
|
+
term?: string;
|
|
458
|
+
timeRange?: InstantRange;
|
|
459
|
+
}
|
|
460
|
+
|
|
354
461
|
export interface FindMyRides {
|
|
355
462
|
accountId?: string;
|
|
356
463
|
descending?: boolean;
|
|
@@ -371,6 +478,16 @@ export interface FindMyUsers {
|
|
|
371
478
|
term?: string;
|
|
372
479
|
}
|
|
373
480
|
|
|
481
|
+
export interface FindPotentialRideSeries {
|
|
482
|
+
accountId?: string;
|
|
483
|
+
descending?: boolean;
|
|
484
|
+
filter?: RideInfoFilter;
|
|
485
|
+
maxSize?: number;
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* @deprecated
|
|
490
|
+
*/
|
|
374
491
|
export interface FindPotentialRides {
|
|
375
492
|
accountId?: string;
|
|
376
493
|
descending?: boolean;
|
|
@@ -386,6 +503,22 @@ export interface FindRides {
|
|
|
386
503
|
term?: string;
|
|
387
504
|
}
|
|
388
505
|
|
|
506
|
+
export interface FindRidesForDriver {
|
|
507
|
+
accountId?: string;
|
|
508
|
+
descending?: boolean;
|
|
509
|
+
filter?: RideFilter;
|
|
510
|
+
maxSize?: number;
|
|
511
|
+
term?: string;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
export interface FindRidesInMarketplace {
|
|
515
|
+
accountId?: string;
|
|
516
|
+
descending?: boolean;
|
|
517
|
+
filter?: RideFilter;
|
|
518
|
+
maxSize?: number;
|
|
519
|
+
term?: string;
|
|
520
|
+
}
|
|
521
|
+
|
|
389
522
|
export interface FindRidesResult {
|
|
390
523
|
count?: RideFilterCount;
|
|
391
524
|
rides?: Ride[];
|
|
@@ -399,18 +532,37 @@ export interface FindUsers {
|
|
|
399
532
|
term?: string;
|
|
400
533
|
}
|
|
401
534
|
|
|
402
|
-
export interface FleetCommand extends RideCommand {
|
|
403
|
-
}
|
|
404
|
-
|
|
405
|
-
export interface FleetModifyCommand extends FleetCommand {
|
|
406
|
-
}
|
|
407
|
-
|
|
408
535
|
export interface GenerateToken {
|
|
409
536
|
accountPermission?: AccountPermission;
|
|
410
537
|
info?: TokenInfo;
|
|
411
538
|
tokenId?: string;
|
|
412
539
|
}
|
|
413
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
|
|
543
|
+
|
|
544
|
+
*/
|
|
545
|
+
export interface GenericRideInfo {
|
|
546
|
+
ambulanceInfo?: AmbulanceInfo;
|
|
547
|
+
attendantsPresent?: number;
|
|
548
|
+
comment?: string;
|
|
549
|
+
dimensions?: PersonDimensions;
|
|
550
|
+
distanceInMeters?: number;
|
|
551
|
+
from?: AddressInfo;
|
|
552
|
+
/**
|
|
553
|
+
* Derived from weightInKg != null
|
|
554
|
+
*/
|
|
555
|
+
heavyWeight?: boolean;
|
|
556
|
+
mobility?: Mobility;
|
|
557
|
+
patient?: Person;
|
|
558
|
+
plannedDuration?: RideDuration;
|
|
559
|
+
preferredDriver?: string;
|
|
560
|
+
purpose?: RidePurpose;
|
|
561
|
+
to?: AddressInfo;
|
|
562
|
+
vehicleType?: VehicleType;
|
|
563
|
+
weightInKg?: number;
|
|
564
|
+
}
|
|
565
|
+
|
|
414
566
|
export interface GeoJson {
|
|
415
567
|
features?: Feature[];
|
|
416
568
|
}
|
|
@@ -447,6 +599,18 @@ export interface GetAccountsOfPotentialDrivers extends GetPotentialDrivers {
|
|
|
447
599
|
export interface GetAccountsOfPotentialDriversAsAdmin extends GetPotentialDrivers {
|
|
448
600
|
}
|
|
449
601
|
|
|
602
|
+
export interface GetAllRideSeriesForDriver {
|
|
603
|
+
accountId?: string;
|
|
604
|
+
descending?: boolean;
|
|
605
|
+
maxSize?: number;
|
|
606
|
+
timeRange?: InstantRange;
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
export interface GetAllRideSeriesInMarketplace {
|
|
610
|
+
accountId?: string;
|
|
611
|
+
maxSize?: number;
|
|
612
|
+
}
|
|
613
|
+
|
|
450
614
|
export interface GetDistrict {
|
|
451
615
|
geoLocation?: GeoLocation;
|
|
452
616
|
stateNutsCode?: string;
|
|
@@ -467,9 +631,22 @@ export interface GetIsoStates {
|
|
|
467
631
|
export interface GetMonopolyAccounts {
|
|
468
632
|
}
|
|
469
633
|
|
|
634
|
+
/**
|
|
635
|
+
* @deprecated
|
|
636
|
+
*/
|
|
637
|
+
export interface GetMyAcceptedRides {
|
|
638
|
+
accountId?: string;
|
|
639
|
+
maxSize?: number;
|
|
640
|
+
timeRange?: InstantRange;
|
|
641
|
+
}
|
|
642
|
+
|
|
470
643
|
export interface GetMyAccounts {
|
|
644
|
+
filter?: AccountFilter;
|
|
471
645
|
}
|
|
472
646
|
|
|
647
|
+
/**
|
|
648
|
+
* @deprecated
|
|
649
|
+
*/
|
|
473
650
|
export interface GetMyRideOffers {
|
|
474
651
|
accountId?: string;
|
|
475
652
|
maxSize?: number;
|
|
@@ -494,11 +671,14 @@ export interface GetNutsStates {
|
|
|
494
671
|
export interface GetPotentialDrivers {
|
|
495
672
|
fromDistrict?: string;
|
|
496
673
|
mobility?: Mobility;
|
|
497
|
-
rideType?: RideType;
|
|
498
674
|
toDistrict?: string;
|
|
675
|
+
vehicleType?: VehicleType;
|
|
499
676
|
weightInKg?: number;
|
|
500
677
|
}
|
|
501
678
|
|
|
679
|
+
/**
|
|
680
|
+
* @deprecated
|
|
681
|
+
*/
|
|
502
682
|
export interface GetPotentialRides {
|
|
503
683
|
accountId?: string;
|
|
504
684
|
maxSize?: number;
|
|
@@ -512,14 +692,45 @@ export interface GetRide {
|
|
|
512
692
|
export interface GetRideCsv extends RideStatisticsQuery {
|
|
513
693
|
}
|
|
514
694
|
|
|
515
|
-
export interface
|
|
516
|
-
|
|
695
|
+
export interface GetRideDataForBooker extends RideStatisticsQuery {
|
|
696
|
+
accountId?: string;
|
|
697
|
+
}
|
|
698
|
+
|
|
699
|
+
export interface GetRideDataForDriver extends RideStatisticsQuery {
|
|
700
|
+
accountId?: string;
|
|
517
701
|
}
|
|
518
702
|
|
|
519
703
|
export interface GetRideLog {
|
|
520
704
|
rideId?: string;
|
|
521
705
|
}
|
|
522
706
|
|
|
707
|
+
export interface GetRideSeries {
|
|
708
|
+
rideSeriesId?: string;
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
export interface GetRideSeriesForDriver {
|
|
712
|
+
accountId?: string;
|
|
713
|
+
maxSize?: number;
|
|
714
|
+
timeRange?: InstantRange;
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
export interface GetRidesForDriver {
|
|
718
|
+
accountId?: string;
|
|
719
|
+
maxSize?: number;
|
|
720
|
+
timeRange?: InstantRange;
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
export interface GetRidesInMarketplace {
|
|
724
|
+
accountId?: string;
|
|
725
|
+
maxSize?: number;
|
|
726
|
+
timeRange?: InstantRange;
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
export interface GetRidesInSeries {
|
|
730
|
+
filter?: RideFilter;
|
|
731
|
+
rideSeriesId?: string;
|
|
732
|
+
}
|
|
733
|
+
|
|
523
734
|
export interface GetTeam {
|
|
524
735
|
teamId?: string;
|
|
525
736
|
}
|
|
@@ -586,6 +797,16 @@ export interface IsoState {
|
|
|
586
797
|
nutsCode?: string;
|
|
587
798
|
}
|
|
588
799
|
|
|
800
|
+
export interface Metric {
|
|
801
|
+
clientId?: string;
|
|
802
|
+
clientSegment?: number[];
|
|
803
|
+
maxSize?: number;
|
|
804
|
+
maxTimeout?: string;
|
|
805
|
+
tokenId?: string;
|
|
806
|
+
type?: string;
|
|
807
|
+
updates?: string[];
|
|
808
|
+
}
|
|
809
|
+
|
|
589
810
|
export interface NutsDistrict {
|
|
590
811
|
code?: string;
|
|
591
812
|
name?: string;
|
|
@@ -608,6 +829,9 @@ export interface OffsetTimeRange {
|
|
|
608
829
|
start?: Date;
|
|
609
830
|
}
|
|
610
831
|
|
|
832
|
+
export interface OptimizerMessage {
|
|
833
|
+
}
|
|
834
|
+
|
|
611
835
|
export interface Person {
|
|
612
836
|
address?: AddressInfo;
|
|
613
837
|
birthDay?: string;
|
|
@@ -632,6 +856,24 @@ export interface PersonDimensions {
|
|
|
632
856
|
export interface PhoneNumber {
|
|
633
857
|
}
|
|
634
858
|
|
|
859
|
+
export interface PlanRide extends RideDriverModifyCommand {
|
|
860
|
+
plannedStartTime?: string;
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
export interface ReadUpdates {
|
|
864
|
+
clientId?: string;
|
|
865
|
+
maxSize?: number;
|
|
866
|
+
maxTimeout?: number;
|
|
867
|
+
tokenId?: string;
|
|
868
|
+
updateTypes?: TrackingUpdateType[];
|
|
869
|
+
}
|
|
870
|
+
|
|
871
|
+
export interface ReadUpdatesResult {
|
|
872
|
+
clientSegment?: number[];
|
|
873
|
+
lastIndex?: number;
|
|
874
|
+
updates?: any[];
|
|
875
|
+
}
|
|
876
|
+
|
|
635
877
|
export interface Region {
|
|
636
878
|
nutsCode?: string;
|
|
637
879
|
}
|
|
@@ -640,16 +882,11 @@ export interface RegisterAuthenticationToken extends UserUpdate {
|
|
|
640
882
|
hashedToken?: string;
|
|
641
883
|
}
|
|
642
884
|
|
|
643
|
-
export interface
|
|
644
|
-
destinationEta?: string;
|
|
645
|
-
originEta?: string;
|
|
646
|
-
}
|
|
647
|
-
|
|
648
|
-
export interface RegisterDriveStatus extends FleetModifyCommand {
|
|
885
|
+
export interface RegisterDriveStatus extends RideDriverModifyCommand {
|
|
649
886
|
driveStatus?: DriveStatus;
|
|
650
887
|
}
|
|
651
888
|
|
|
652
|
-
export interface RegisterDriverSynced extends
|
|
889
|
+
export interface RegisterDriverSynced extends RideDriverModifyCommand {
|
|
653
890
|
}
|
|
654
891
|
|
|
655
892
|
export interface RegisterEinsatz {
|
|
@@ -676,6 +913,13 @@ export interface ReportIssue {
|
|
|
676
913
|
issue?: string;
|
|
677
914
|
}
|
|
678
915
|
|
|
916
|
+
/**
|
|
917
|
+
* Can only report delays when ride has started and has not arrived at destination.
|
|
918
|
+
*/
|
|
919
|
+
export interface ReportRideDelay extends RideDriverModifyCommand {
|
|
920
|
+
minutes?: number;
|
|
921
|
+
}
|
|
922
|
+
|
|
679
923
|
export interface RequestDrivePermission extends AccountUpdate {
|
|
680
924
|
drivePermissionId?: string;
|
|
681
925
|
info?: DrivePermissionInfoRequest;
|
|
@@ -690,6 +934,34 @@ export interface RequestUserReset {
|
|
|
690
934
|
email?: string;
|
|
691
935
|
}
|
|
692
936
|
|
|
937
|
+
/**
|
|
938
|
+
* Resets the lastIndex position of your token.
|
|
939
|
+
*/
|
|
940
|
+
export interface ResetPosition {
|
|
941
|
+
index?: number;
|
|
942
|
+
timestamp?: string;
|
|
943
|
+
tokenId?: string;
|
|
944
|
+
}
|
|
945
|
+
|
|
946
|
+
export interface ReturnRide extends RideDriverModifyCommand {
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
export interface ReturnRideSeries extends RideDriverSeriesCommand {
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
export interface Review {
|
|
953
|
+
comment?: string;
|
|
954
|
+
stars?: number;
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
export interface ReviewRideAsBooker extends RideBookerCommand {
|
|
958
|
+
review?: Review;
|
|
959
|
+
}
|
|
960
|
+
|
|
961
|
+
export interface ReviewRideAsDriver extends RideDriverModifyCommand {
|
|
962
|
+
review?: Review;
|
|
963
|
+
}
|
|
964
|
+
|
|
693
965
|
export interface RevokeAccountPermission extends AccountPermissionCommand {
|
|
694
966
|
}
|
|
695
967
|
|
|
@@ -706,14 +978,22 @@ export interface RevokeToken extends TokenUpdate {
|
|
|
706
978
|
|
|
707
979
|
export interface Ride {
|
|
708
980
|
/**
|
|
709
|
-
* Derived from
|
|
981
|
+
* Derived from driver != null
|
|
710
982
|
*/
|
|
711
983
|
accepted?: boolean;
|
|
984
|
+
actualEndTime?: string;
|
|
985
|
+
actualStartTime?: string;
|
|
986
|
+
/**
|
|
987
|
+
* Derived from driveStatus != null
|
|
988
|
+
*/
|
|
989
|
+
arrived?: boolean;
|
|
712
990
|
/**
|
|
713
991
|
* Derived from bookedTime != null
|
|
714
992
|
*/
|
|
715
993
|
booked?: boolean;
|
|
716
994
|
bookedTime?: string;
|
|
995
|
+
booker?: AccountOrTeamRef;
|
|
996
|
+
bookerReview?: Review;
|
|
717
997
|
bookingStatus?: BookingStatus;
|
|
718
998
|
cancelReason?: string;
|
|
719
999
|
cancelled?: boolean;
|
|
@@ -722,37 +1002,72 @@ export interface Ride {
|
|
|
722
1002
|
*/
|
|
723
1003
|
completed?: boolean;
|
|
724
1004
|
/**
|
|
725
|
-
*
|
|
1005
|
+
* Desired Time of Arrival at the Destination/Drop-off location. Derived from info.appointment and info.plannedDuration
|
|
726
1006
|
*/
|
|
727
|
-
|
|
1007
|
+
desiredEndTime?: string;
|
|
728
1008
|
/**
|
|
729
|
-
*
|
|
1009
|
+
* Desired Time of Arrival at the Origin/Pick-up location. Derived from info.appointment and info.plannedDuration
|
|
730
1010
|
*/
|
|
731
|
-
|
|
732
|
-
driveOwner?: AccountOrTeamRef;
|
|
1011
|
+
desiredStartTime?: string;
|
|
733
1012
|
driveStatus?: DriveStatus;
|
|
1013
|
+
driver?: AccountOrTeamRef;
|
|
1014
|
+
driverReview?: Review;
|
|
734
1015
|
driverSyncStatus?: SyncStatus;
|
|
1016
|
+
endTimeDelay?: number;
|
|
1017
|
+
/**
|
|
1018
|
+
* Expected Time of Arrival at the Destination/Drop-off location.
|
|
1019
|
+
*/
|
|
1020
|
+
expectedEndTime?: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* Expected Time of Arrival at the Origin/Pick-up location.
|
|
1023
|
+
*/
|
|
1024
|
+
expectedStartTime?: string;
|
|
735
1025
|
info?: RideInfo;
|
|
736
1026
|
/**
|
|
737
|
-
*
|
|
1027
|
+
* Derived from plannedStartTime != null
|
|
738
1028
|
*/
|
|
739
|
-
|
|
1029
|
+
planned?: boolean;
|
|
740
1030
|
/**
|
|
741
|
-
* Planned Time of Arrival at the
|
|
1031
|
+
* Planned Time of Arrival at the Destination/Drop-off location, reported by the driver.
|
|
742
1032
|
*/
|
|
743
|
-
|
|
1033
|
+
plannedEndTime?: string;
|
|
1034
|
+
plannedStartTime?: string;
|
|
744
1035
|
rideId?: string;
|
|
745
|
-
|
|
1036
|
+
/**
|
|
1037
|
+
* The time until which rides can be found. It's the planned time or else the desired time.
|
|
1038
|
+
*/
|
|
1039
|
+
searchEndTime?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* The time from which rides can be found. It's the planned time or else the desired time.
|
|
1042
|
+
*/
|
|
1043
|
+
searchStartTime?: string;
|
|
1044
|
+
seriesInfo?: SeriesInfo;
|
|
1045
|
+
startTimeDelay?: number;
|
|
746
1046
|
/**
|
|
747
1047
|
* Derived from driveStatus != null
|
|
748
1048
|
*/
|
|
749
1049
|
started?: boolean;
|
|
750
1050
|
}
|
|
751
1051
|
|
|
1052
|
+
export interface RideBookerCommand extends RideCommand {
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
export interface RideBookerSeriesCommand extends RideSeriesCommand {
|
|
1056
|
+
}
|
|
1057
|
+
|
|
752
1058
|
export interface RideCommand {
|
|
753
1059
|
rideId?: string;
|
|
754
1060
|
}
|
|
755
1061
|
|
|
1062
|
+
export interface RideDriverCommand extends RideCommand {
|
|
1063
|
+
}
|
|
1064
|
+
|
|
1065
|
+
export interface RideDriverModifyCommand extends RideDriverCommand {
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
|
|
1069
|
+
}
|
|
1070
|
+
|
|
756
1071
|
/**
|
|
757
1072
|
* All durations in seconds
|
|
758
1073
|
*/
|
|
@@ -765,38 +1080,39 @@ export interface RideDuration {
|
|
|
765
1080
|
|
|
766
1081
|
export interface RideFilter {
|
|
767
1082
|
bookingStatuses?: BookingStatus[];
|
|
768
|
-
directions?: Direction[];
|
|
769
1083
|
driveStatuses?: DriveStatus[];
|
|
770
1084
|
driverAccountNames?: string[];
|
|
771
1085
|
driverTeamNames?: string[];
|
|
772
1086
|
hasInfection?: boolean;
|
|
773
1087
|
heavyWeight?: boolean;
|
|
774
1088
|
mobilities?: Mobility[];
|
|
1089
|
+
purposes?: RidePurpose[];
|
|
1090
|
+
region?: Region;
|
|
775
1091
|
requiresMonitoring?: boolean;
|
|
776
1092
|
requiresOxygen?: boolean;
|
|
777
1093
|
requiresSuctionAspirator?: boolean;
|
|
778
|
-
rideType?: RideType;
|
|
779
1094
|
riderAccountNames?: string[];
|
|
780
1095
|
riderTeamNames?: string[];
|
|
781
1096
|
timeRange?: InstantRange;
|
|
1097
|
+
vehicleType?: VehicleType;
|
|
782
1098
|
}
|
|
783
1099
|
|
|
784
1100
|
export interface RideFilterCount {
|
|
785
1101
|
bookingStatuses?: { [P in BookingStatus]?: number };
|
|
786
|
-
directions?: { [P in Direction]?: number };
|
|
787
1102
|
driveStatuses?: { [P in DriveStatus]?: number };
|
|
788
1103
|
driverAccountNames?: { [index: string]: number };
|
|
789
1104
|
driverTeamNames?: { [index: string]: number };
|
|
790
1105
|
hasInfection?: number;
|
|
791
1106
|
heavyWeight?: number;
|
|
792
1107
|
mobilities?: { [P in Mobility]?: number };
|
|
1108
|
+
purposes?: { [P in RidePurpose]?: number };
|
|
793
1109
|
requiresMonitoring?: number;
|
|
794
1110
|
requiresOxygen?: number;
|
|
795
1111
|
requiresSuctionAspirator?: number;
|
|
796
|
-
rideTypes?: { [P in RideType]?: number };
|
|
797
1112
|
riderAccountNames?: { [index: string]: number };
|
|
798
1113
|
riderTeamNames?: { [index: string]: number };
|
|
799
1114
|
total?: number;
|
|
1115
|
+
vehicleTypes?: { [P in VehicleType]?: number };
|
|
800
1116
|
}
|
|
801
1117
|
|
|
802
1118
|
export interface RideIdResult {
|
|
@@ -812,7 +1128,6 @@ export interface RideInfo {
|
|
|
812
1128
|
attendantsPresent?: number;
|
|
813
1129
|
comment?: string;
|
|
814
1130
|
dimensions?: PersonDimensions;
|
|
815
|
-
direction?: Direction;
|
|
816
1131
|
distanceInMeters?: number;
|
|
817
1132
|
from?: AddressInfo;
|
|
818
1133
|
/**
|
|
@@ -823,11 +1138,24 @@ export interface RideInfo {
|
|
|
823
1138
|
patient?: Person;
|
|
824
1139
|
plannedDuration?: RideDuration;
|
|
825
1140
|
preferredDriver?: string;
|
|
826
|
-
|
|
1141
|
+
purpose?: RidePurpose;
|
|
827
1142
|
to?: AddressInfo;
|
|
1143
|
+
vehicleType?: VehicleType;
|
|
828
1144
|
weightInKg?: number;
|
|
829
1145
|
}
|
|
830
1146
|
|
|
1147
|
+
export interface RideInfoFilter {
|
|
1148
|
+
hasInfection?: boolean;
|
|
1149
|
+
heavyWeight?: boolean;
|
|
1150
|
+
mobilities?: Mobility[];
|
|
1151
|
+
purposes?: RidePurpose[];
|
|
1152
|
+
region?: Region;
|
|
1153
|
+
requiresMonitoring?: boolean;
|
|
1154
|
+
requiresOxygen?: boolean;
|
|
1155
|
+
requiresSuctionAspirator?: boolean;
|
|
1156
|
+
vehicleType?: VehicleType;
|
|
1157
|
+
}
|
|
1158
|
+
|
|
831
1159
|
export interface RideLog {
|
|
832
1160
|
actingFor?: AccountOrTeamRef;
|
|
833
1161
|
allowedViewers?: AccountOrTeamRef[];
|
|
@@ -848,15 +1176,67 @@ export interface RideOfferInfo {
|
|
|
848
1176
|
appointment?: Appointment;
|
|
849
1177
|
}
|
|
850
1178
|
|
|
851
|
-
export interface
|
|
1179
|
+
export interface RideSeries {
|
|
1180
|
+
accepted?: boolean;
|
|
1181
|
+
booked?: boolean;
|
|
1182
|
+
booker?: AccountOrTeamRef;
|
|
1183
|
+
cancelled?: boolean;
|
|
1184
|
+
confirmed?: boolean;
|
|
1185
|
+
driver?: AccountOrTeamRef;
|
|
1186
|
+
endTime?: string;
|
|
1187
|
+
info?: GenericRideInfo;
|
|
1188
|
+
rideSeriesId?: string;
|
|
1189
|
+
rides?: SingleRide[];
|
|
1190
|
+
startTime?: string;
|
|
1191
|
+
status?: RideSeriesStatus;
|
|
1192
|
+
}
|
|
1193
|
+
|
|
1194
|
+
export interface RideSeriesCommand {
|
|
1195
|
+
rideSeriesId?: string;
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
export interface RideSeriesIdResult {
|
|
1199
|
+
rideSeriesId?: string;
|
|
1200
|
+
}
|
|
1201
|
+
|
|
1202
|
+
export interface RideSeriesPostConfirmCommand {
|
|
1203
|
+
rideSeriesId?: string;
|
|
1204
|
+
ridesToModify?: Ride[];
|
|
1205
|
+
}
|
|
1206
|
+
|
|
1207
|
+
export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
|
|
1208
|
+
}
|
|
1209
|
+
|
|
1210
|
+
export interface RideSeriesUpdate {
|
|
1211
|
+
after?: RideSeries;
|
|
1212
|
+
before?: RideSeries;
|
|
1213
|
+
entityId?: string;
|
|
1214
|
+
eventType?: string;
|
|
1215
|
+
index?: number;
|
|
1216
|
+
timestamp?: string;
|
|
1217
|
+
type: "rideseries";
|
|
852
1218
|
}
|
|
853
1219
|
|
|
854
1220
|
export interface RideStatisticsQuery {
|
|
855
1221
|
dateRange?: DateRange;
|
|
1222
|
+
timezoneOrDefault?: string;
|
|
1223
|
+
zoneId?: string;
|
|
856
1224
|
}
|
|
857
1225
|
|
|
858
|
-
export interface
|
|
859
|
-
|
|
1226
|
+
export interface RideSystemCommand extends RideCommand {
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
export interface RideUpcaster {
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
export interface RideUpdate {
|
|
1233
|
+
after?: Ride;
|
|
1234
|
+
before?: Ride;
|
|
1235
|
+
entityId?: string;
|
|
1236
|
+
eventType?: string;
|
|
1237
|
+
index?: number;
|
|
1238
|
+
timestamp?: string;
|
|
1239
|
+
type: "ride";
|
|
860
1240
|
}
|
|
861
1241
|
|
|
862
1242
|
export interface Role<T> {
|
|
@@ -866,8 +1246,8 @@ export interface Role<T> {
|
|
|
866
1246
|
* Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
|
|
867
1247
|
*/
|
|
868
1248
|
export interface SaveRide extends CreateRideCommand {
|
|
1249
|
+
booker?: AccountOrTeamRef;
|
|
869
1250
|
info?: RideInfo;
|
|
870
|
-
owner?: AccountOrTeamRef;
|
|
871
1251
|
}
|
|
872
1252
|
|
|
873
1253
|
export interface SendConfirmationEmail {
|
|
@@ -893,6 +1273,14 @@ export interface SendSlack {
|
|
|
893
1273
|
message?: string;
|
|
894
1274
|
}
|
|
895
1275
|
|
|
1276
|
+
/**
|
|
1277
|
+
* Information about a ride that is part of series.
|
|
1278
|
+
*/
|
|
1279
|
+
export interface SeriesInfo {
|
|
1280
|
+
returnTrip?: boolean;
|
|
1281
|
+
rideSeriesId?: string;
|
|
1282
|
+
}
|
|
1283
|
+
|
|
896
1284
|
export interface SetSettings extends AccountUpdate {
|
|
897
1285
|
settings?: any;
|
|
898
1286
|
}
|
|
@@ -920,6 +1308,19 @@ export interface SignUpUser {
|
|
|
920
1308
|
userId?: string;
|
|
921
1309
|
}
|
|
922
1310
|
|
|
1311
|
+
/**
|
|
1312
|
+
* Individual ride timing within a series
|
|
1313
|
+
*/
|
|
1314
|
+
export interface SingleRide {
|
|
1315
|
+
desiredStartTime?: string;
|
|
1316
|
+
returnTrip?: boolean;
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
export interface SingleRideUpdate {
|
|
1320
|
+
desiredStartTime?: string;
|
|
1321
|
+
rideId?: string;
|
|
1322
|
+
}
|
|
1323
|
+
|
|
923
1324
|
export interface StopImpersonatingUser {
|
|
924
1325
|
}
|
|
925
1326
|
|
|
@@ -933,7 +1334,7 @@ export interface SubscriptionInfo extends TimedPermission {
|
|
|
933
1334
|
service?: Service;
|
|
934
1335
|
}
|
|
935
1336
|
|
|
936
|
-
export interface TaxiFilter extends
|
|
1337
|
+
export interface TaxiFilter extends DrivePermissionFilter {
|
|
937
1338
|
allowedMobilities?: Mobility[];
|
|
938
1339
|
type: "taxi";
|
|
939
1340
|
}
|
|
@@ -1000,9 +1401,24 @@ export interface UpdateAccountPermission extends AccountPermissionCommand {
|
|
|
1000
1401
|
accountPermission?: AccountPermission;
|
|
1001
1402
|
}
|
|
1002
1403
|
|
|
1003
|
-
export interface
|
|
1404
|
+
export interface UpdatePosition {
|
|
1405
|
+
clientSegment?: number[];
|
|
1406
|
+
lastIndex?: number;
|
|
1407
|
+
tokenId?: string;
|
|
1408
|
+
}
|
|
1409
|
+
|
|
1410
|
+
export interface UpdateRide extends RideBookerCommand {
|
|
1411
|
+
booker?: AccountOrTeamRef;
|
|
1004
1412
|
info?: RideInfo;
|
|
1005
|
-
|
|
1413
|
+
}
|
|
1414
|
+
|
|
1415
|
+
export interface UpdateRidePlan extends RideDriverModifyCommand {
|
|
1416
|
+
plannedStartTime?: string;
|
|
1417
|
+
}
|
|
1418
|
+
|
|
1419
|
+
export interface UpdateRideSeries extends RideBookerSeriesCommand {
|
|
1420
|
+
info?: GenericRideInfo;
|
|
1421
|
+
rides?: SingleRide[];
|
|
1006
1422
|
}
|
|
1007
1423
|
|
|
1008
1424
|
export interface UpdateTeam extends TeamUpdate {
|
|
@@ -1018,6 +1434,9 @@ export interface UpdateUserInfo extends UserEdit {
|
|
|
1018
1434
|
info?: UserInfo;
|
|
1019
1435
|
}
|
|
1020
1436
|
|
|
1437
|
+
export interface UserAndTokenUpcaster {
|
|
1438
|
+
}
|
|
1439
|
+
|
|
1021
1440
|
export interface UserCommand {
|
|
1022
1441
|
userId?: string;
|
|
1023
1442
|
}
|
|
@@ -1029,7 +1448,7 @@ export interface UserInfo {
|
|
|
1029
1448
|
firstName?: string;
|
|
1030
1449
|
language?: string;
|
|
1031
1450
|
lastName?: string;
|
|
1032
|
-
telephoneNumber?:
|
|
1451
|
+
telephoneNumber?: PhoneNumber;
|
|
1033
1452
|
}
|
|
1034
1453
|
|
|
1035
1454
|
export interface UserOrTokenId {
|
|
@@ -1058,13 +1477,13 @@ export interface ZonedTimeRange {
|
|
|
1058
1477
|
start?: Date;
|
|
1059
1478
|
}
|
|
1060
1479
|
|
|
1061
|
-
export type AccountRole = "
|
|
1480
|
+
export type AccountRole = "ridebooker" | "dispatcher" | "admin" | "owner";
|
|
1062
1481
|
|
|
1063
1482
|
export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
|
|
1064
1483
|
|
|
1065
|
-
export type BookingStatus = "saved" | "booked" | "accepted" | "started" | "completed" | "cancelled";
|
|
1484
|
+
export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
|
|
1066
1485
|
|
|
1067
|
-
export type
|
|
1486
|
+
export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
|
|
1068
1487
|
|
|
1069
1488
|
export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
|
|
1070
1489
|
|
|
@@ -1074,20 +1493,26 @@ export type InsuranceType = "public_insurance" | "private_insurance" | "german_a
|
|
|
1074
1493
|
|
|
1075
1494
|
export type IntegrationType = "dispolive" | "celios";
|
|
1076
1495
|
|
|
1077
|
-
export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "
|
|
1496
|
+
export type Mobility = "wheelchair" | "big_or_electric_wheelchair" | "carry_chair" | "stretcher";
|
|
1497
|
+
|
|
1498
|
+
export type OrganisationType = "medical" | "fleet";
|
|
1078
1499
|
|
|
1079
|
-
export type
|
|
1500
|
+
export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
|
|
1080
1501
|
|
|
1081
|
-
export type
|
|
1502
|
+
export type RideSeriesStatus = "booked" | "accepted" | "confirmed" | "cancelled";
|
|
1082
1503
|
|
|
1083
|
-
export type Service = "
|
|
1504
|
+
export type Service = "pro_medical" | "pro_fleet" | "celios_integration" | "dispolive_integration";
|
|
1084
1505
|
|
|
1085
1506
|
export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
|
|
1086
1507
|
|
|
1087
|
-
export type StandaloneService = "
|
|
1508
|
+
export type StandaloneService = "pro_medical" | "pro_fleet";
|
|
1088
1509
|
|
|
1089
1510
|
export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
|
|
1090
1511
|
|
|
1091
|
-
export type TeamRole = "
|
|
1512
|
+
export type TeamRole = "dispatcher" | "ridebooker";
|
|
1513
|
+
|
|
1514
|
+
export type TrackingUpdateType = "ride" | "rideseries";
|
|
1092
1515
|
|
|
1093
1516
|
export type UserRole = "superadmin";
|
|
1517
|
+
|
|
1518
|
+
export type VehicleType = "taxi" | "ambulance";
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|