@moxi.gmbh/moxi-typescriptmodels 0.1.1391-test-server → 0.1.1391
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-with-namespaces.d.ts +3021 -0
- package/common.d.ts +474 -272
- package/package.json +1 -1
package/common.d.ts
CHANGED
|
@@ -1,9 +1,43 @@
|
|
|
1
1
|
|
|
2
|
+
export interface AbstractFindMyRides {
|
|
3
|
+
accountId?: string;
|
|
4
|
+
descending?: boolean;
|
|
5
|
+
filter?: RideFilter;
|
|
6
|
+
maxSize?: number;
|
|
7
|
+
term?: string;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export interface AbstractFindRides {
|
|
11
|
+
descending?: boolean;
|
|
12
|
+
filter?: RideFilter;
|
|
13
|
+
maxSize?: number;
|
|
14
|
+
term?: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface AbstractFindRidesForDriver {
|
|
18
|
+
accountId?: string;
|
|
19
|
+
descending?: boolean;
|
|
20
|
+
filter?: RideFilter;
|
|
21
|
+
maxSize?: number;
|
|
22
|
+
term?: string;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface AbstractFindRidesInMarketplace {
|
|
26
|
+
accountId?: string;
|
|
27
|
+
descending?: boolean;
|
|
28
|
+
filter?: RideFilter;
|
|
29
|
+
/**
|
|
30
|
+
* @deprecated
|
|
31
|
+
*/
|
|
32
|
+
maxSize?: number;
|
|
33
|
+
term?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
2
36
|
export interface AcceptRide extends RideDriverCommand {
|
|
3
37
|
driver?: AccountOrTeamRef;
|
|
4
38
|
}
|
|
5
39
|
|
|
6
|
-
export interface AcceptRideSeries extends
|
|
40
|
+
export interface AcceptRideSeries extends SeriesDriverCommand {
|
|
7
41
|
driver?: AccountOrTeamRef;
|
|
8
42
|
}
|
|
9
43
|
|
|
@@ -27,7 +61,7 @@ export interface Account {
|
|
|
27
61
|
info?: AccountInfo;
|
|
28
62
|
integrationSettings?: any[];
|
|
29
63
|
operateAccounts?: string[];
|
|
30
|
-
|
|
64
|
+
operators?: string[];
|
|
31
65
|
/**
|
|
32
66
|
* Derived from subscriptions. Includes organisation types that have not been confirmed yet by a superadmin or are active in past or future.
|
|
33
67
|
*/
|
|
@@ -47,6 +81,7 @@ export interface AccountFilter {
|
|
|
47
81
|
|
|
48
82
|
export interface AccountInfo {
|
|
49
83
|
address?: AddressInfo;
|
|
84
|
+
companyInfo?: CompanyInfo;
|
|
50
85
|
defaultLanguage?: string;
|
|
51
86
|
notificationEmails?: string[];
|
|
52
87
|
phoneNumber?: PhoneNumber;
|
|
@@ -73,6 +108,10 @@ export interface AccountPermissionCommand extends UserUpdate {
|
|
|
73
108
|
accountId?: string;
|
|
74
109
|
}
|
|
75
110
|
|
|
111
|
+
export interface AccountPermissionFilter {
|
|
112
|
+
roles?: AccountRole[];
|
|
113
|
+
}
|
|
114
|
+
|
|
76
115
|
export interface AccountRef {
|
|
77
116
|
accountId?: string;
|
|
78
117
|
name?: string;
|
|
@@ -84,14 +123,15 @@ export interface AccountUpcaster {
|
|
|
84
123
|
export interface AccountUpdate extends AccountCommand {
|
|
85
124
|
}
|
|
86
125
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
126
|
+
export interface AddOperations extends AccountUpdate {
|
|
127
|
+
operateAccount?: string;
|
|
128
|
+
}
|
|
129
|
+
|
|
90
130
|
export interface AddressInfo {
|
|
91
131
|
addition?: string;
|
|
92
132
|
city?: string;
|
|
93
133
|
/**
|
|
94
|
-
*
|
|
134
|
+
* The NUTS country code, derived from districtNutsCode
|
|
95
135
|
*/
|
|
96
136
|
country?: string;
|
|
97
137
|
districtNutsCode?: string;
|
|
@@ -100,12 +140,12 @@ export interface AddressInfo {
|
|
|
100
140
|
number?: string;
|
|
101
141
|
placeName?: string;
|
|
102
142
|
/**
|
|
103
|
-
*
|
|
143
|
+
* The NUTS level 1 code, derived from districtNutsCode
|
|
104
144
|
*/
|
|
105
145
|
state?: string;
|
|
106
146
|
street?: string;
|
|
107
147
|
/**
|
|
108
|
-
*
|
|
148
|
+
* The NUTS level 2 code, derived from districtNutsCode
|
|
109
149
|
*/
|
|
110
150
|
subState?: string;
|
|
111
151
|
zipCode?: string;
|
|
@@ -125,38 +165,31 @@ export interface AmbulanceFilter extends DrivePermissionFilter {
|
|
|
125
165
|
}
|
|
126
166
|
|
|
127
167
|
/**
|
|
128
|
-
*
|
|
168
|
+
* Mandatory if the vehicleType is ambulance, forbidden if taxi
|
|
129
169
|
*/
|
|
130
170
|
export interface AmbulanceInfo {
|
|
131
171
|
/**
|
|
132
|
-
*
|
|
172
|
+
* True if infectionDescription is given
|
|
133
173
|
*/
|
|
134
174
|
hasInfection?: boolean;
|
|
135
175
|
infectionDescription?: string;
|
|
136
176
|
monitoringDescription?: string;
|
|
137
177
|
oxygenLiterPerHour?: number;
|
|
138
178
|
/**
|
|
139
|
-
*
|
|
179
|
+
* True if monitoringDescription is given
|
|
140
180
|
*/
|
|
141
181
|
requiresMonitoring?: boolean;
|
|
142
182
|
/**
|
|
143
|
-
*
|
|
183
|
+
* True if oxygenLiterPerHour is given
|
|
144
184
|
*/
|
|
145
185
|
requiresOxygen?: boolean;
|
|
146
186
|
requiresSuctionAspirator?: boolean;
|
|
147
187
|
}
|
|
148
188
|
|
|
149
|
-
|
|
150
|
-
* Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
|
|
151
|
-
|
|
152
|
-
*/
|
|
153
|
-
export interface AnonymizedGenericRideInfo extends GenericRideInfo {
|
|
189
|
+
export interface AnonymizedRideInfo extends RideInfo {
|
|
154
190
|
}
|
|
155
191
|
|
|
156
|
-
|
|
157
|
-
* Information about the ride, from the creator of the ride
|
|
158
|
-
*/
|
|
159
|
-
export interface AnonymizedRideInfo extends RideInfo {
|
|
192
|
+
export interface AnonymizedSeriesRideInfo extends SeriesRideInfo {
|
|
160
193
|
}
|
|
161
194
|
|
|
162
195
|
export interface Appointment {
|
|
@@ -164,7 +197,11 @@ export interface Appointment {
|
|
|
164
197
|
time?: string;
|
|
165
198
|
}
|
|
166
199
|
|
|
167
|
-
export interface AssignDriver extends
|
|
200
|
+
export interface AssignDriver extends RideOperatorCommand {
|
|
201
|
+
driver?: AccountOrTeamRef;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
export interface AssignRideSeriesDriver extends SeriesOperatorCommand {
|
|
168
205
|
driver?: AccountOrTeamRef;
|
|
169
206
|
}
|
|
170
207
|
|
|
@@ -181,44 +218,38 @@ export interface AuthenticateWithToken extends UserUpdate {
|
|
|
181
218
|
export interface AuthenticationResponse {
|
|
182
219
|
authorizationHeader?: string;
|
|
183
220
|
impersonator?: string;
|
|
221
|
+
refreshToken?: string;
|
|
222
|
+
refreshTokenDeadline?: string;
|
|
184
223
|
result?: AuthenticationResult;
|
|
185
224
|
sessionDeadline?: string;
|
|
186
225
|
userProfile?: UserProfile;
|
|
187
226
|
}
|
|
188
227
|
|
|
189
|
-
export interface
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
export interface BatchUpdateRideSeriesInfo extends RideSeriesPostConfirmCommand {
|
|
193
|
-
info?: GenericRideInfo;
|
|
194
|
-
updater?: AccountOrTeamRef;
|
|
228
|
+
export interface AuthenticationResponseFactory {
|
|
195
229
|
}
|
|
196
230
|
|
|
197
|
-
export interface
|
|
198
|
-
rides?: SingleRideUpdate[];
|
|
199
|
-
updater?: AccountOrTeamRef;
|
|
231
|
+
export interface AuthenticationService {
|
|
200
232
|
}
|
|
201
233
|
|
|
202
234
|
export interface BookRide extends CreateRideCommand {
|
|
203
|
-
booker?: AccountOrTeamRef;
|
|
204
235
|
info?: RideInfo;
|
|
205
236
|
}
|
|
206
237
|
|
|
207
|
-
export interface BookRideSeries extends
|
|
208
|
-
|
|
209
|
-
info?: GenericRideInfo;
|
|
210
|
-
rides?: SingleRide[];
|
|
238
|
+
export interface BookRideSeries extends CreateSeriesCommand {
|
|
239
|
+
rideSummaries?: RideSummary[];
|
|
211
240
|
}
|
|
212
241
|
|
|
213
242
|
export interface CancelRide extends RideBookerCommand {
|
|
214
243
|
reason?: string;
|
|
215
244
|
}
|
|
216
245
|
|
|
217
|
-
export interface CancelRideSeries extends
|
|
246
|
+
export interface CancelRideSeries extends SeriesCommandWithSeparateEvent {
|
|
247
|
+
reason?: string;
|
|
218
248
|
}
|
|
219
249
|
|
|
220
|
-
export interface
|
|
221
|
-
|
|
250
|
+
export interface CancelRideSeriesEvent extends SeriesBookerCommand {
|
|
251
|
+
cancelRides?: string[];
|
|
252
|
+
reason?: string;
|
|
222
253
|
}
|
|
223
254
|
|
|
224
255
|
export interface CeliosSettings {
|
|
@@ -240,6 +271,28 @@ export interface CheckIfUserSignedUp {
|
|
|
240
271
|
userId?: string;
|
|
241
272
|
}
|
|
242
273
|
|
|
274
|
+
export interface CheckSession {
|
|
275
|
+
userId?: string;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* You can send in custom values. For every value you don't send in, we lookup the default setting you set up in your account.
|
|
280
|
+
*/
|
|
281
|
+
export interface CleaningAndSlack {
|
|
282
|
+
cleaningAtGarage?: boolean;
|
|
283
|
+
cleaningDuration?: number;
|
|
284
|
+
dropoffDuration?: number;
|
|
285
|
+
pickupDuration?: number;
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
export interface CompanyInfo {
|
|
289
|
+
businessLicenseDocument?: Document;
|
|
290
|
+
creationDate?: string;
|
|
291
|
+
hasLiabilityInsurance?: boolean;
|
|
292
|
+
publicLiabilityPolicyDocument?: Document;
|
|
293
|
+
registrationNumber?: string;
|
|
294
|
+
}
|
|
295
|
+
|
|
243
296
|
export interface ConfirmAccount extends AccountCommand {
|
|
244
297
|
}
|
|
245
298
|
|
|
@@ -255,6 +308,7 @@ export interface ConfirmSubscription extends AccountUpdate {
|
|
|
255
308
|
}
|
|
256
309
|
|
|
257
310
|
export interface ConfirmUser {
|
|
311
|
+
activateOneTimePassword?: boolean;
|
|
258
312
|
token?: string;
|
|
259
313
|
userId?: string;
|
|
260
314
|
}
|
|
@@ -278,17 +332,12 @@ export interface CreateOptimizationPlan extends OptimizerMessage {
|
|
|
278
332
|
}
|
|
279
333
|
|
|
280
334
|
export interface CreateRideCommand extends RideBookerCommand {
|
|
281
|
-
booker?: AccountOrTeamId;
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
export interface CreateRideFromSeries extends RideDriverCommand {
|
|
285
335
|
booker?: AccountOrTeamRef;
|
|
286
|
-
driver?: AccountOrTeamRef;
|
|
287
|
-
info?: RideInfo;
|
|
288
|
-
seriesInfo?: SeriesInfo;
|
|
289
336
|
}
|
|
290
337
|
|
|
291
|
-
export interface
|
|
338
|
+
export interface CreateSeriesCommand extends SeriesBookerCommand {
|
|
339
|
+
booker?: AccountOrTeamRef;
|
|
340
|
+
info?: SeriesRideInfo;
|
|
292
341
|
}
|
|
293
342
|
|
|
294
343
|
export interface CreateSqueezeInPlan extends OptimizerMessage {
|
|
@@ -324,6 +373,11 @@ export interface DateRange {
|
|
|
324
373
|
export interface DeleteUser extends UserEdit {
|
|
325
374
|
}
|
|
326
375
|
|
|
376
|
+
export interface DetailsFilter extends WebsocketFilter {
|
|
377
|
+
id?: string;
|
|
378
|
+
screen: "ride_details";
|
|
379
|
+
}
|
|
380
|
+
|
|
327
381
|
export interface DisconnectClient {
|
|
328
382
|
clientId?: string;
|
|
329
383
|
tokenId?: string;
|
|
@@ -347,6 +401,12 @@ export interface DistrictInfo {
|
|
|
347
401
|
type?: string;
|
|
348
402
|
}
|
|
349
403
|
|
|
404
|
+
export interface Document {
|
|
405
|
+
id?: string;
|
|
406
|
+
name?: string;
|
|
407
|
+
size?: number;
|
|
408
|
+
}
|
|
409
|
+
|
|
350
410
|
export interface DownloadableFile {
|
|
351
411
|
base64Data?: string;
|
|
352
412
|
fileName?: string;
|
|
@@ -434,47 +494,25 @@ export interface FindAccounts {
|
|
|
434
494
|
term?: string;
|
|
435
495
|
}
|
|
436
496
|
|
|
437
|
-
|
|
438
|
-
* @deprecated
|
|
439
|
-
*/
|
|
440
|
-
export interface FindMyAcceptedRides {
|
|
497
|
+
export interface FindDuplicateRides {
|
|
441
498
|
accountId?: string;
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
499
|
+
appointmentTime?: string;
|
|
500
|
+
patientBirthDay?: string;
|
|
501
|
+
patientFirstName?: string;
|
|
502
|
+
patientLastName?: string;
|
|
446
503
|
}
|
|
447
504
|
|
|
448
|
-
|
|
449
|
-
* @deprecated
|
|
450
|
-
*/
|
|
451
|
-
export interface FindMyRideOffers {
|
|
452
|
-
accountId?: string;
|
|
453
|
-
descending?: boolean;
|
|
454
|
-
filter?: RideFilter;
|
|
455
|
-
maxSize?: number;
|
|
456
|
-
term?: string;
|
|
505
|
+
export interface FindMyRides extends AbstractFindMyRides {
|
|
457
506
|
}
|
|
458
507
|
|
|
459
|
-
export interface
|
|
460
|
-
accountId?: string;
|
|
461
|
-
descending?: boolean;
|
|
462
|
-
maxSize?: number;
|
|
463
|
-
term?: string;
|
|
464
|
-
timeRange?: InstantRange;
|
|
508
|
+
export interface FindMyRidesAndSeries extends AbstractFindMyRides {
|
|
465
509
|
}
|
|
466
510
|
|
|
467
|
-
export interface
|
|
468
|
-
accountId?: string;
|
|
469
|
-
descending?: boolean;
|
|
470
|
-
filter?: RideFilter;
|
|
471
|
-
maxSize?: number;
|
|
472
|
-
term?: string;
|
|
511
|
+
export interface FindMySeries extends AbstractFindMyRides {
|
|
473
512
|
}
|
|
474
513
|
|
|
475
514
|
export interface FindMyTokens {
|
|
476
515
|
accountId?: string;
|
|
477
|
-
teamId?: string;
|
|
478
516
|
term?: string;
|
|
479
517
|
}
|
|
480
518
|
|
|
@@ -484,45 +522,27 @@ export interface FindMyUsers {
|
|
|
484
522
|
term?: string;
|
|
485
523
|
}
|
|
486
524
|
|
|
487
|
-
export interface
|
|
488
|
-
accountId?: string;
|
|
489
|
-
descending?: boolean;
|
|
490
|
-
filter?: RideInfoFilter;
|
|
491
|
-
maxSize?: number;
|
|
525
|
+
export interface FindRides extends AbstractFindRides {
|
|
492
526
|
}
|
|
493
527
|
|
|
494
|
-
|
|
495
|
-
* @deprecated
|
|
496
|
-
*/
|
|
497
|
-
export interface FindPotentialRides {
|
|
498
|
-
accountId?: string;
|
|
499
|
-
descending?: boolean;
|
|
500
|
-
filter?: RideFilter;
|
|
501
|
-
maxSize?: number;
|
|
502
|
-
term?: string;
|
|
528
|
+
export interface FindRidesAndSeries extends AbstractFindRides {
|
|
503
529
|
}
|
|
504
530
|
|
|
505
|
-
export interface
|
|
506
|
-
descending?: boolean;
|
|
507
|
-
filter?: RideFilter;
|
|
508
|
-
maxSize?: number;
|
|
509
|
-
term?: string;
|
|
531
|
+
export interface FindRidesAndSeriesForDriver extends AbstractFindRidesForDriver {
|
|
510
532
|
}
|
|
511
533
|
|
|
512
|
-
export interface
|
|
513
|
-
accountId?: string;
|
|
514
|
-
descending?: boolean;
|
|
515
|
-
filter?: RideFilter;
|
|
516
|
-
maxSize?: number;
|
|
517
|
-
term?: string;
|
|
534
|
+
export interface FindRidesAndSeriesInMarketplace extends AbstractFindRidesInMarketplace {
|
|
518
535
|
}
|
|
519
536
|
|
|
520
|
-
export interface
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
537
|
+
export interface FindRidesAndSeriesResult {
|
|
538
|
+
ridesAndSeries?: RideOrMinimizedSeries[];
|
|
539
|
+
ridesCount?: RideFilterCount;
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
export interface FindRidesForDriver extends AbstractFindRidesForDriver {
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
export interface FindRidesInMarketplace extends AbstractFindRidesInMarketplace {
|
|
526
546
|
}
|
|
527
547
|
|
|
528
548
|
export interface FindRidesResult {
|
|
@@ -530,24 +550,47 @@ export interface FindRidesResult {
|
|
|
530
550
|
rides?: Ride[];
|
|
531
551
|
}
|
|
532
552
|
|
|
553
|
+
export interface FindSeries extends AbstractFindRides {
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
export interface FindSeriesForDriver extends AbstractFindRidesForDriver {
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
export interface FindSeriesInMarketplace extends AbstractFindRidesInMarketplace {
|
|
560
|
+
}
|
|
561
|
+
|
|
533
562
|
export interface FindTokens {
|
|
534
563
|
term?: string;
|
|
535
564
|
}
|
|
536
565
|
|
|
537
566
|
export interface FindUsers {
|
|
567
|
+
accountFilter?: AccountFilter;
|
|
568
|
+
accountPermissionFilter?: AccountPermissionFilter;
|
|
538
569
|
term?: string;
|
|
539
570
|
}
|
|
540
571
|
|
|
572
|
+
export interface FirebaseMessage {
|
|
573
|
+
data?: { [index: string]: string };
|
|
574
|
+
notification?: Notification;
|
|
575
|
+
topic?: string;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
export interface FleetOverviewFilter extends WebsocketFilter {
|
|
579
|
+
queryFilter?: FindRidesAndSeriesForDriver;
|
|
580
|
+
screen: "fleet_overview";
|
|
581
|
+
}
|
|
582
|
+
|
|
541
583
|
export interface GenerateToken {
|
|
542
584
|
accountPermission?: AccountPermission;
|
|
543
585
|
info?: TokenInfo;
|
|
544
586
|
tokenId?: string;
|
|
545
587
|
}
|
|
546
588
|
|
|
547
|
-
|
|
548
|
-
|
|
589
|
+
export interface GenerateTokenResult {
|
|
590
|
+
entity?: Token;
|
|
591
|
+
jwt?: string;
|
|
592
|
+
}
|
|
549
593
|
|
|
550
|
-
*/
|
|
551
594
|
export interface GenericRideInfo {
|
|
552
595
|
ambulanceInfo?: AmbulanceInfo;
|
|
553
596
|
attendantsPresent?: number;
|
|
@@ -563,7 +606,6 @@ export interface GenericRideInfo {
|
|
|
563
606
|
patient?: Person;
|
|
564
607
|
plannedDuration?: RideDuration;
|
|
565
608
|
preferredDriver?: string;
|
|
566
|
-
purpose?: RidePurpose;
|
|
567
609
|
to?: AddressInfo;
|
|
568
610
|
vehicleType?: VehicleType;
|
|
569
611
|
weightInKg?: number;
|
|
@@ -599,22 +641,16 @@ export interface GetAccount {
|
|
|
599
641
|
accountId?: string;
|
|
600
642
|
}
|
|
601
643
|
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
export interface
|
|
606
|
-
}
|
|
607
|
-
|
|
608
|
-
export interface GetAllRideSeriesForDriver {
|
|
609
|
-
accountId?: string;
|
|
610
|
-
descending?: boolean;
|
|
611
|
-
maxSize?: number;
|
|
612
|
-
timeRange?: InstantRange;
|
|
644
|
+
/**
|
|
645
|
+
* @deprecated
|
|
646
|
+
*/
|
|
647
|
+
export interface GetAccountsOfPotentialDrivers extends IGetPotentialDrivers {
|
|
613
648
|
}
|
|
614
649
|
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
650
|
+
/**
|
|
651
|
+
* @deprecated
|
|
652
|
+
*/
|
|
653
|
+
export interface GetAccountsOfPotentialDriversAsAdmin extends IGetPotentialDrivers {
|
|
618
654
|
}
|
|
619
655
|
|
|
620
656
|
export interface GetDistrict {
|
|
@@ -637,29 +673,17 @@ export interface GetIsoStates {
|
|
|
637
673
|
export interface GetMonopolyAccounts {
|
|
638
674
|
}
|
|
639
675
|
|
|
640
|
-
/**
|
|
641
|
-
* @deprecated
|
|
642
|
-
*/
|
|
643
|
-
export interface GetMyAcceptedRides {
|
|
644
|
-
accountId?: string;
|
|
645
|
-
maxSize?: number;
|
|
646
|
-
timeRange?: InstantRange;
|
|
647
|
-
}
|
|
648
|
-
|
|
649
676
|
export interface GetMyAccounts {
|
|
650
677
|
filter?: AccountFilter;
|
|
651
678
|
}
|
|
652
679
|
|
|
653
|
-
|
|
654
|
-
* @deprecated
|
|
655
|
-
*/
|
|
656
|
-
export interface GetMyRideOffers {
|
|
680
|
+
export interface GetMyRides {
|
|
657
681
|
accountId?: string;
|
|
658
682
|
maxSize?: number;
|
|
659
683
|
timeRange?: InstantRange;
|
|
660
684
|
}
|
|
661
685
|
|
|
662
|
-
export interface
|
|
686
|
+
export interface GetMySeries {
|
|
663
687
|
accountId?: string;
|
|
664
688
|
maxSize?: number;
|
|
665
689
|
timeRange?: InstantRange;
|
|
@@ -674,21 +698,25 @@ export interface GetMyUserProfile {
|
|
|
674
698
|
export interface GetNutsStates {
|
|
675
699
|
}
|
|
676
700
|
|
|
677
|
-
export interface
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
weightInKg?: number;
|
|
701
|
+
export interface GetOneSeries {
|
|
702
|
+
rideSeriesId?: string;
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
export interface GetPotentialDriverIds extends GetPotentialDriversAbstract {
|
|
683
706
|
}
|
|
684
707
|
|
|
685
708
|
/**
|
|
686
|
-
*
|
|
709
|
+
* Common information shared across all rides in a series. Similar to RideInfo but without appointment-specific details that vary per ride.
|
|
710
|
+
|
|
687
711
|
*/
|
|
688
|
-
export interface
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
712
|
+
export interface GetPotentialDrivers extends GetPotentialDriversAbstract {
|
|
713
|
+
}
|
|
714
|
+
|
|
715
|
+
export interface GetPotentialDriversAbstract {
|
|
716
|
+
fromDistrict?: string;
|
|
717
|
+
mobility?: Mobility;
|
|
718
|
+
vehicleType?: VehicleType;
|
|
719
|
+
weightInKg?: number;
|
|
692
720
|
}
|
|
693
721
|
|
|
694
722
|
export interface GetRide {
|
|
@@ -710,30 +738,38 @@ export interface GetRideLog {
|
|
|
710
738
|
rideId?: string;
|
|
711
739
|
}
|
|
712
740
|
|
|
713
|
-
export interface
|
|
714
|
-
|
|
741
|
+
export interface GetRideOrSeries {
|
|
742
|
+
id?: string;
|
|
715
743
|
}
|
|
716
744
|
|
|
717
|
-
export interface
|
|
745
|
+
export interface GetRidesForDriver {
|
|
718
746
|
accountId?: string;
|
|
719
747
|
maxSize?: number;
|
|
720
748
|
timeRange?: InstantRange;
|
|
721
749
|
}
|
|
722
750
|
|
|
723
|
-
export interface
|
|
751
|
+
export interface GetRidesInMarketplace {
|
|
724
752
|
accountId?: string;
|
|
725
753
|
maxSize?: number;
|
|
726
754
|
timeRange?: InstantRange;
|
|
727
755
|
}
|
|
728
756
|
|
|
729
|
-
export interface
|
|
757
|
+
export interface GetRidesInSeries {
|
|
758
|
+
rideSeriesId?: string;
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
export interface GetSeriesForDriver {
|
|
730
762
|
accountId?: string;
|
|
731
763
|
maxSize?: number;
|
|
732
764
|
timeRange?: InstantRange;
|
|
733
765
|
}
|
|
734
766
|
|
|
735
|
-
export interface
|
|
736
|
-
|
|
767
|
+
export interface GetSeriesInMarketplace {
|
|
768
|
+
accountId?: string;
|
|
769
|
+
maxSize?: number;
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
export interface GetSeriesLog {
|
|
737
773
|
rideSeriesId?: string;
|
|
738
774
|
}
|
|
739
775
|
|
|
@@ -763,6 +799,23 @@ export interface GiveTeamPermission extends AccountPermissionCommand {
|
|
|
763
799
|
teamPermission?: TeamPermission;
|
|
764
800
|
}
|
|
765
801
|
|
|
802
|
+
export interface HalfHourBeforeStart {
|
|
803
|
+
rideId?: string;
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
export interface HospitalOverviewFilter extends WebsocketFilter {
|
|
807
|
+
queryFilter?: FindMyRidesAndSeries;
|
|
808
|
+
screen: "hospital_overview";
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
export interface IGetPotentialDrivers {
|
|
812
|
+
fromDistrict?: string;
|
|
813
|
+
mobility?: Mobility;
|
|
814
|
+
toDistrict?: string;
|
|
815
|
+
vehicleType?: VehicleType;
|
|
816
|
+
weightInKg?: number;
|
|
817
|
+
}
|
|
818
|
+
|
|
766
819
|
export interface ImpersonateUser {
|
|
767
820
|
userId?: string;
|
|
768
821
|
}
|
|
@@ -803,6 +856,11 @@ export interface IsoState {
|
|
|
803
856
|
nutsCode?: string;
|
|
804
857
|
}
|
|
805
858
|
|
|
859
|
+
export interface MarketplaceOverviewFilter extends WebsocketFilter {
|
|
860
|
+
queryFilter?: FindRidesAndSeriesInMarketplace;
|
|
861
|
+
screen: "marketplace";
|
|
862
|
+
}
|
|
863
|
+
|
|
806
864
|
export interface Metric {
|
|
807
865
|
clientId?: string;
|
|
808
866
|
clientSegment?: number[];
|
|
@@ -813,6 +871,18 @@ export interface Metric {
|
|
|
813
871
|
updates?: string[];
|
|
814
872
|
}
|
|
815
873
|
|
|
874
|
+
/**
|
|
875
|
+
* A series of rides.
|
|
876
|
+
*/
|
|
877
|
+
export interface MinimizedRideSeries extends RideSeries, RideOrMinimizedSeries {
|
|
878
|
+
info?: SeriesRideInfo;
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
export interface Notification {
|
|
882
|
+
body?: string;
|
|
883
|
+
title?: string;
|
|
884
|
+
}
|
|
885
|
+
|
|
816
886
|
export interface NutsDistrict {
|
|
817
887
|
code?: string;
|
|
818
888
|
name?: string;
|
|
@@ -835,6 +905,25 @@ export interface OffsetTimeRange {
|
|
|
835
905
|
start?: Date;
|
|
836
906
|
}
|
|
837
907
|
|
|
908
|
+
export interface OneHourAfterEnd {
|
|
909
|
+
rideId?: string;
|
|
910
|
+
}
|
|
911
|
+
|
|
912
|
+
export interface OneTimePasswordExpires {
|
|
913
|
+
userId?: string;
|
|
914
|
+
}
|
|
915
|
+
|
|
916
|
+
export interface OneTimePasswordState {
|
|
917
|
+
hashedPassword?: string;
|
|
918
|
+
loginAttempts?: number;
|
|
919
|
+
userId?: string;
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
export interface OperationsOverviewFilter extends WebsocketFilter {
|
|
923
|
+
queryFilter?: FindRidesAndSeries;
|
|
924
|
+
screen: "operations_overview";
|
|
925
|
+
}
|
|
926
|
+
|
|
838
927
|
export interface OptimizerMessage {
|
|
839
928
|
}
|
|
840
929
|
|
|
@@ -851,7 +940,7 @@ export interface Person {
|
|
|
851
940
|
}
|
|
852
941
|
|
|
853
942
|
/**
|
|
854
|
-
*
|
|
943
|
+
* Mandatory if weight exceeds 130 kg, otherwise forbidden
|
|
855
944
|
*/
|
|
856
945
|
export interface PersonDimensions {
|
|
857
946
|
heightInCm?: number;
|
|
@@ -871,7 +960,7 @@ export interface ReadUpdates {
|
|
|
871
960
|
maxSize?: number;
|
|
872
961
|
maxTimeout?: number;
|
|
873
962
|
tokenId?: string;
|
|
874
|
-
updateTypes?:
|
|
963
|
+
updateTypes?: EntityType[];
|
|
875
964
|
}
|
|
876
965
|
|
|
877
966
|
export interface ReadUpdatesResult {
|
|
@@ -880,6 +969,19 @@ export interface ReadUpdatesResult {
|
|
|
880
969
|
updates?: any[];
|
|
881
970
|
}
|
|
882
971
|
|
|
972
|
+
export interface RefreshTokenData {
|
|
973
|
+
expiresAt?: string;
|
|
974
|
+
hashedToken?: string;
|
|
975
|
+
userId?: string;
|
|
976
|
+
}
|
|
977
|
+
|
|
978
|
+
export interface RefreshTokenService {
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
export interface RefreshUserToken {
|
|
982
|
+
refreshToken?: string;
|
|
983
|
+
}
|
|
984
|
+
|
|
883
985
|
export interface Region {
|
|
884
986
|
nutsCode?: string;
|
|
885
987
|
}
|
|
@@ -900,9 +1002,22 @@ export interface RegisterEinsatz {
|
|
|
900
1002
|
rideId?: string;
|
|
901
1003
|
}
|
|
902
1004
|
|
|
1005
|
+
export interface RegisterOneTimePassword {
|
|
1006
|
+
oneTimePassword?: string;
|
|
1007
|
+
userId?: string;
|
|
1008
|
+
}
|
|
1009
|
+
|
|
903
1010
|
export interface RemoveAccount extends AccountUpdate {
|
|
904
1011
|
}
|
|
905
1012
|
|
|
1013
|
+
export interface RemoveOperations extends AccountUpdate {
|
|
1014
|
+
operateAccount?: string;
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
export interface RemoveOperator extends AccountUpdate {
|
|
1018
|
+
operator?: string;
|
|
1019
|
+
}
|
|
1020
|
+
|
|
906
1021
|
export interface RemoveSettings extends AccountUpdate {
|
|
907
1022
|
type?: IntegrationType;
|
|
908
1023
|
}
|
|
@@ -952,7 +1067,7 @@ export interface ResetPosition {
|
|
|
952
1067
|
export interface ReturnRide extends RideDriverModifyCommand {
|
|
953
1068
|
}
|
|
954
1069
|
|
|
955
|
-
export interface ReturnRideSeries extends
|
|
1070
|
+
export interface ReturnRideSeries extends SeriesDriverCommand {
|
|
956
1071
|
}
|
|
957
1072
|
|
|
958
1073
|
export interface Review {
|
|
@@ -975,6 +1090,9 @@ export interface RevokeDrivePermission extends AccountUpdate {
|
|
|
975
1090
|
drivePermissionId?: string;
|
|
976
1091
|
}
|
|
977
1092
|
|
|
1093
|
+
export interface RevokeSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
|
|
1094
|
+
}
|
|
1095
|
+
|
|
978
1096
|
export interface RevokeSubscription extends AccountUpdate {
|
|
979
1097
|
subscriptionId?: string;
|
|
980
1098
|
}
|
|
@@ -982,75 +1100,69 @@ export interface RevokeSubscription extends AccountUpdate {
|
|
|
982
1100
|
export interface RevokeToken extends TokenUpdate {
|
|
983
1101
|
}
|
|
984
1102
|
|
|
985
|
-
export interface
|
|
1103
|
+
export interface RevokeUserRefreshTokens {
|
|
1104
|
+
userId?: string;
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
export interface Ride extends RideOrSeries, RideOrMinimizedSeries {
|
|
986
1108
|
/**
|
|
987
|
-
*
|
|
1109
|
+
* 'accepted' is true if a driver has accepted the ride.
|
|
988
1110
|
*/
|
|
989
1111
|
accepted?: boolean;
|
|
1112
|
+
acceptedTime?: string;
|
|
990
1113
|
actualEndTime?: string;
|
|
991
1114
|
actualStartTime?: string;
|
|
992
1115
|
/**
|
|
993
|
-
*
|
|
1116
|
+
* 'arrived' is true if the driver has reported driveStatus is 'arrived_at_origin'.
|
|
994
1117
|
*/
|
|
995
1118
|
arrived?: boolean;
|
|
996
1119
|
/**
|
|
997
|
-
*
|
|
1120
|
+
* 'booked' is false if the ride has only been saved.
|
|
998
1121
|
*/
|
|
999
1122
|
booked?: boolean;
|
|
1000
|
-
bookedTime?: string;
|
|
1001
1123
|
booker?: AccountOrTeamRef;
|
|
1002
1124
|
bookerReview?: Review;
|
|
1003
|
-
bookingStatus?: BookingStatus;
|
|
1004
1125
|
cancelReason?: string;
|
|
1005
1126
|
cancelled?: boolean;
|
|
1006
1127
|
/**
|
|
1007
|
-
*
|
|
1128
|
+
* 'completed' is true if the driver has reported driveStatus is 'completed'.
|
|
1008
1129
|
*/
|
|
1009
1130
|
completed?: boolean;
|
|
1010
1131
|
/**
|
|
1011
|
-
*
|
|
1132
|
+
* The booker determines the desiredEndTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'to' or 'drop-off' location.
|
|
1012
1133
|
*/
|
|
1013
1134
|
desiredEndTime?: string;
|
|
1014
1135
|
/**
|
|
1015
|
-
*
|
|
1136
|
+
* The booker determines the desiredStartTime via 'info.appointment' and 'info.plannedDuration'. It means the desired time of arrival at the 'from' or 'pick-up' location.
|
|
1016
1137
|
*/
|
|
1017
1138
|
desiredStartTime?: string;
|
|
1018
1139
|
driveStatus?: DriveStatus;
|
|
1019
|
-
driver?: AccountOrTeamRef;
|
|
1020
1140
|
driverReview?: Review;
|
|
1021
1141
|
driverSyncStatus?: SyncStatus;
|
|
1022
1142
|
endTimeDelay?: number;
|
|
1023
1143
|
/**
|
|
1024
|
-
*
|
|
1144
|
+
* The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'to' or 'drop-off' location.
|
|
1025
1145
|
*/
|
|
1026
1146
|
expectedEndTime?: string;
|
|
1027
1147
|
/**
|
|
1028
|
-
*
|
|
1148
|
+
* The driver determines the expectedEndTime when indicating delays. It means the expected time of arrival at the 'from' or 'pick-up' location.
|
|
1029
1149
|
*/
|
|
1030
1150
|
expectedStartTime?: string;
|
|
1031
1151
|
info?: RideInfo;
|
|
1032
1152
|
/**
|
|
1033
|
-
*
|
|
1153
|
+
* 'planned' is true if the driver has reported a planned time for the ride.
|
|
1034
1154
|
*/
|
|
1035
1155
|
planned?: boolean;
|
|
1036
1156
|
/**
|
|
1037
|
-
*
|
|
1157
|
+
* The driver determines the plannedEndTime. It means the planned time of arrival at the 'to' or 'drop-off' location.
|
|
1038
1158
|
*/
|
|
1039
1159
|
plannedEndTime?: string;
|
|
1040
1160
|
plannedStartTime?: string;
|
|
1041
1161
|
rideId?: string;
|
|
1042
|
-
/**
|
|
1043
|
-
* The time until which rides can be found. It's the planned time or else the desired time.
|
|
1044
|
-
*/
|
|
1045
|
-
searchEndTime?: string;
|
|
1046
|
-
/**
|
|
1047
|
-
* The time from which rides can be found. It's the planned time or else the desired time.
|
|
1048
|
-
*/
|
|
1049
|
-
searchStartTime?: string;
|
|
1050
1162
|
seriesInfo?: SeriesInfo;
|
|
1051
1163
|
startTimeDelay?: number;
|
|
1052
1164
|
/**
|
|
1053
|
-
*
|
|
1165
|
+
* 'started' is true if the driver has reported a driveStatus.
|
|
1054
1166
|
*/
|
|
1055
1167
|
started?: boolean;
|
|
1056
1168
|
}
|
|
@@ -1058,9 +1170,6 @@ export interface Ride {
|
|
|
1058
1170
|
export interface RideBookerCommand extends RideCommand {
|
|
1059
1171
|
}
|
|
1060
1172
|
|
|
1061
|
-
export interface RideBookerSeriesCommand extends RideSeriesCommand {
|
|
1062
|
-
}
|
|
1063
|
-
|
|
1064
1173
|
export interface RideCommand {
|
|
1065
1174
|
rideId?: string;
|
|
1066
1175
|
}
|
|
@@ -1071,16 +1180,19 @@ export interface RideDriverCommand extends RideCommand {
|
|
|
1071
1180
|
export interface RideDriverModifyCommand extends RideDriverCommand {
|
|
1072
1181
|
}
|
|
1073
1182
|
|
|
1074
|
-
export interface RideDriverSeriesCommand extends RideSeriesPreConfirmCommand {
|
|
1075
|
-
}
|
|
1076
|
-
|
|
1077
|
-
/**
|
|
1078
|
-
* All durations in seconds
|
|
1079
|
-
*/
|
|
1080
1183
|
export interface RideDuration {
|
|
1081
1184
|
driving?: number;
|
|
1185
|
+
/**
|
|
1186
|
+
* Seconds of slack for dropping off the patient, currently hardcoded to 15 minutes
|
|
1187
|
+
*/
|
|
1082
1188
|
droppingOff?: number;
|
|
1189
|
+
/**
|
|
1190
|
+
* Seconds of slack for picking up the patient, currently hardcoded to 15 minutes
|
|
1191
|
+
*/
|
|
1083
1192
|
pickingUp?: number;
|
|
1193
|
+
/**
|
|
1194
|
+
* Seconds of driving time plus the pick-up and drop-off slack times
|
|
1195
|
+
*/
|
|
1084
1196
|
total?: number;
|
|
1085
1197
|
}
|
|
1086
1198
|
|
|
@@ -1089,6 +1201,7 @@ export interface RideFilter {
|
|
|
1089
1201
|
driveStatuses?: DriveStatus[];
|
|
1090
1202
|
driverAccountNames?: string[];
|
|
1091
1203
|
driverTeamNames?: string[];
|
|
1204
|
+
entityType?: EntityType;
|
|
1092
1205
|
hasInfection?: boolean;
|
|
1093
1206
|
heavyWeight?: boolean;
|
|
1094
1207
|
mobilities?: Mobility[];
|
|
@@ -1100,6 +1213,7 @@ export interface RideFilter {
|
|
|
1100
1213
|
riderAccountNames?: string[];
|
|
1101
1214
|
riderTeamNames?: string[];
|
|
1102
1215
|
timeRange?: InstantRange;
|
|
1216
|
+
unfoldRideSeries?: boolean;
|
|
1103
1217
|
vehicleType?: VehicleType;
|
|
1104
1218
|
}
|
|
1105
1219
|
|
|
@@ -1125,41 +1239,9 @@ export interface RideIdResult {
|
|
|
1125
1239
|
rideId?: string;
|
|
1126
1240
|
}
|
|
1127
1241
|
|
|
1128
|
-
|
|
1129
|
-
* Information about the ride, from the creator of the ride
|
|
1130
|
-
*/
|
|
1131
|
-
export interface RideInfo {
|
|
1132
|
-
ambulanceInfo?: AmbulanceInfo;
|
|
1242
|
+
export interface RideInfo extends GenericRideInfo {
|
|
1133
1243
|
appointment?: Appointment;
|
|
1134
|
-
attendantsPresent?: number;
|
|
1135
|
-
comment?: string;
|
|
1136
|
-
dimensions?: PersonDimensions;
|
|
1137
|
-
distanceInMeters?: number;
|
|
1138
|
-
from?: AddressInfo;
|
|
1139
|
-
/**
|
|
1140
|
-
* Derived from weightInKg != null
|
|
1141
|
-
*/
|
|
1142
|
-
heavyWeight?: boolean;
|
|
1143
|
-
mobility?: Mobility;
|
|
1144
|
-
patient?: Person;
|
|
1145
|
-
plannedDuration?: RideDuration;
|
|
1146
|
-
preferredDriver?: string;
|
|
1147
1244
|
purpose?: RidePurpose;
|
|
1148
|
-
to?: AddressInfo;
|
|
1149
|
-
vehicleType?: VehicleType;
|
|
1150
|
-
weightInKg?: number;
|
|
1151
|
-
}
|
|
1152
|
-
|
|
1153
|
-
export interface RideInfoFilter {
|
|
1154
|
-
hasInfection?: boolean;
|
|
1155
|
-
heavyWeight?: boolean;
|
|
1156
|
-
mobilities?: Mobility[];
|
|
1157
|
-
purposes?: RidePurpose[];
|
|
1158
|
-
region?: Region;
|
|
1159
|
-
requiresMonitoring?: boolean;
|
|
1160
|
-
requiresOxygen?: boolean;
|
|
1161
|
-
requiresSuctionAspirator?: boolean;
|
|
1162
|
-
vehicleType?: VehicleType;
|
|
1163
1245
|
}
|
|
1164
1246
|
|
|
1165
1247
|
export interface RideLog {
|
|
@@ -1178,39 +1260,64 @@ export interface RideLog {
|
|
|
1178
1260
|
token?: boolean;
|
|
1179
1261
|
}
|
|
1180
1262
|
|
|
1181
|
-
export interface
|
|
1182
|
-
appointment?: Appointment;
|
|
1263
|
+
export interface RideOperatorCommand extends RideCommand {
|
|
1183
1264
|
}
|
|
1184
1265
|
|
|
1185
|
-
export interface
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
booker?: AccountOrTeamRef;
|
|
1189
|
-
cancelled?: boolean;
|
|
1190
|
-
confirmed?: boolean;
|
|
1191
|
-
driver?: AccountOrTeamRef;
|
|
1192
|
-
endTime?: string;
|
|
1266
|
+
export interface RideOrMinimizedSeries {
|
|
1267
|
+
bookingStatus?: BookingStatus;
|
|
1268
|
+
entityType?: EntityType;
|
|
1193
1269
|
info?: GenericRideInfo;
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
startTime?: string;
|
|
1197
|
-
status?: RideSeriesStatus;
|
|
1270
|
+
searchEndTime?: string;
|
|
1271
|
+
searchStartTime?: string;
|
|
1198
1272
|
}
|
|
1199
1273
|
|
|
1200
|
-
export interface
|
|
1201
|
-
|
|
1274
|
+
export interface RideOrSeries {
|
|
1275
|
+
bookedTime?: string;
|
|
1276
|
+
bookingStatus?: BookingStatus;
|
|
1277
|
+
cleaningAndSlack?: CleaningAndSlack;
|
|
1278
|
+
driver?: AccountOrTeamRef;
|
|
1279
|
+
entityType?: EntityType;
|
|
1280
|
+
info?: GenericRideInfo;
|
|
1281
|
+
marketplaceTime?: string;
|
|
1282
|
+
totalDuration?: number;
|
|
1202
1283
|
}
|
|
1203
1284
|
|
|
1204
|
-
|
|
1285
|
+
/**
|
|
1286
|
+
* A series of rides.
|
|
1287
|
+
*/
|
|
1288
|
+
export interface RideSeries extends RideOrSeries {
|
|
1289
|
+
/**
|
|
1290
|
+
* 'accepted' is true if a driver has accepted the series.
|
|
1291
|
+
*/
|
|
1292
|
+
accepted?: boolean;
|
|
1293
|
+
acceptedTime?: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* The number of rides in the series that are not cancelled.
|
|
1296
|
+
*/
|
|
1297
|
+
activeRideCount?: number;
|
|
1298
|
+
/**
|
|
1299
|
+
* 'booked' is false if the series has only been saved.
|
|
1300
|
+
*/
|
|
1301
|
+
booked?: boolean;
|
|
1302
|
+
booker?: AccountOrTeamRef;
|
|
1303
|
+
cancelReason?: string;
|
|
1304
|
+
cancelled?: boolean;
|
|
1305
|
+
info?: SeriesRideInfo;
|
|
1205
1306
|
rideSeriesId?: string;
|
|
1307
|
+
rides?: Ride[];
|
|
1308
|
+
ridesSummaries?: RideSummary[];
|
|
1309
|
+
/**
|
|
1310
|
+
* searchEndTime is the time from which series can be found in our system. It's the searchEndTime of the last ride in the series.
|
|
1311
|
+
*/
|
|
1312
|
+
searchEndTime?: string;
|
|
1313
|
+
/**
|
|
1314
|
+
* searchStartTime is the time from which series can be found in our system. It's the searchStartTime of the first ride in the series.
|
|
1315
|
+
*/
|
|
1316
|
+
searchStartTime?: string;
|
|
1206
1317
|
}
|
|
1207
1318
|
|
|
1208
|
-
export interface
|
|
1319
|
+
export interface RideSeriesIdResult {
|
|
1209
1320
|
rideSeriesId?: string;
|
|
1210
|
-
ridesToModify?: Ride[];
|
|
1211
|
-
}
|
|
1212
|
-
|
|
1213
|
-
export interface RideSeriesPreConfirmCommand extends RideSeriesCommand {
|
|
1214
1321
|
}
|
|
1215
1322
|
|
|
1216
1323
|
export interface RideSeriesUpdate {
|
|
@@ -1223,11 +1330,23 @@ export interface RideSeriesUpdate {
|
|
|
1223
1330
|
type: "rideseries";
|
|
1224
1331
|
}
|
|
1225
1332
|
|
|
1333
|
+
export interface RideSeriesUtils {
|
|
1334
|
+
}
|
|
1335
|
+
|
|
1226
1336
|
export interface RideStatisticsQuery {
|
|
1227
1337
|
dateRange?: DateRange;
|
|
1228
1338
|
zoneId?: string;
|
|
1229
1339
|
}
|
|
1230
1340
|
|
|
1341
|
+
/**
|
|
1342
|
+
* Individual ride timing within a series. Once a ride series is accepted, you cannot add rides, only remove
|
|
1343
|
+
*/
|
|
1344
|
+
export interface RideSummary {
|
|
1345
|
+
appointmentTime?: string;
|
|
1346
|
+
returnTrip?: boolean;
|
|
1347
|
+
rideId?: string;
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1231
1350
|
export interface RideSystemCommand extends RideCommand {
|
|
1232
1351
|
}
|
|
1233
1352
|
|
|
@@ -1244,17 +1363,24 @@ export interface RideUpdate {
|
|
|
1244
1363
|
type: "ride";
|
|
1245
1364
|
}
|
|
1246
1365
|
|
|
1247
|
-
export interface Role
|
|
1366
|
+
export interface Role {
|
|
1248
1367
|
}
|
|
1249
1368
|
|
|
1250
1369
|
/**
|
|
1251
1370
|
* Save a new ride or update a previously saved ride. Not allowed to saveRide after the ride has been booked.
|
|
1252
1371
|
*/
|
|
1253
1372
|
export interface SaveRide extends CreateRideCommand {
|
|
1254
|
-
booker?: AccountOrTeamRef;
|
|
1255
1373
|
info?: RideInfo;
|
|
1256
1374
|
}
|
|
1257
1375
|
|
|
1376
|
+
export interface SaveRideSeries extends CreateSeriesCommand {
|
|
1377
|
+
rideSummaries?: RideSummary[];
|
|
1378
|
+
}
|
|
1379
|
+
|
|
1380
|
+
export interface SecondaryTokenPermissionCommand extends TokenUpdate {
|
|
1381
|
+
accountId?: string;
|
|
1382
|
+
}
|
|
1383
|
+
|
|
1258
1384
|
export interface SendConfirmationEmail {
|
|
1259
1385
|
userId?: string;
|
|
1260
1386
|
}
|
|
@@ -1266,6 +1392,7 @@ export interface SendEmail {
|
|
|
1266
1392
|
export interface SendFreshdeskNewTicket {
|
|
1267
1393
|
email?: string;
|
|
1268
1394
|
message?: string;
|
|
1395
|
+
subject?: string;
|
|
1269
1396
|
}
|
|
1270
1397
|
|
|
1271
1398
|
export interface SendInvitationEmail {
|
|
@@ -1273,20 +1400,57 @@ export interface SendInvitationEmail {
|
|
|
1273
1400
|
userId?: string;
|
|
1274
1401
|
}
|
|
1275
1402
|
|
|
1403
|
+
export interface SendOneTimePasswordEmail {
|
|
1404
|
+
oneTimePassword?: string;
|
|
1405
|
+
userId?: string;
|
|
1406
|
+
}
|
|
1407
|
+
|
|
1408
|
+
export interface SendSensitiveEmail {
|
|
1409
|
+
message?: EmailMessage;
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1276
1412
|
export interface SendSlack {
|
|
1277
1413
|
channel?: SlackChannel;
|
|
1278
1414
|
message?: string;
|
|
1279
1415
|
}
|
|
1280
1416
|
|
|
1417
|
+
export interface SendToFirebase {
|
|
1418
|
+
message?: FirebaseMessage;
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
export interface SeriesBookerCommand extends SeriesCommand {
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1424
|
+
export interface SeriesCommand {
|
|
1425
|
+
rideSeriesId?: string;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
export interface SeriesCommandWithSeparateEvent {
|
|
1429
|
+
rideSeriesId?: string;
|
|
1430
|
+
}
|
|
1431
|
+
|
|
1432
|
+
export interface SeriesDriverCommand extends SeriesCommand {
|
|
1433
|
+
}
|
|
1434
|
+
|
|
1281
1435
|
/**
|
|
1282
|
-
*
|
|
1436
|
+
* If the ride is part of a series, seriesInfo will contain context about the position of the ride within the series.
|
|
1283
1437
|
*/
|
|
1284
1438
|
export interface SeriesInfo {
|
|
1439
|
+
desyncedFromSeries?: boolean;
|
|
1440
|
+
positionInSeries?: number;
|
|
1285
1441
|
returnTrip?: boolean;
|
|
1286
1442
|
rideSeriesId?: string;
|
|
1443
|
+
totalRidesInSeries?: number;
|
|
1287
1444
|
}
|
|
1288
1445
|
|
|
1289
|
-
export interface
|
|
1446
|
+
export interface SeriesOperatorCommand extends SeriesCommand {
|
|
1447
|
+
}
|
|
1448
|
+
|
|
1449
|
+
export interface SeriesRideInfo extends GenericRideInfo {
|
|
1450
|
+
purpose?: SeriesPurpose;
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1453
|
+
export interface SetOperations extends AccountUpdate {
|
|
1290
1454
|
operateAccounts?: string[];
|
|
1291
1455
|
}
|
|
1292
1456
|
|
|
@@ -1294,6 +1458,10 @@ export interface SetOperator extends AccountUpdate {
|
|
|
1294
1458
|
operator?: string;
|
|
1295
1459
|
}
|
|
1296
1460
|
|
|
1461
|
+
export interface SetSecondaryTokenPermission extends SecondaryTokenPermissionCommand {
|
|
1462
|
+
accountPermission?: AccountPermission;
|
|
1463
|
+
}
|
|
1464
|
+
|
|
1297
1465
|
export interface SetSettings extends AccountUpdate {
|
|
1298
1466
|
settings?: any;
|
|
1299
1467
|
}
|
|
@@ -1309,11 +1477,13 @@ export interface SetUserRole extends UserUpdate {
|
|
|
1309
1477
|
}
|
|
1310
1478
|
|
|
1311
1479
|
export interface SignInUser {
|
|
1480
|
+
activateOneTimePassword?: boolean;
|
|
1312
1481
|
password?: string;
|
|
1313
1482
|
userId?: string;
|
|
1314
1483
|
}
|
|
1315
1484
|
|
|
1316
1485
|
export interface SignUpUser {
|
|
1486
|
+
activateOneTimePassword?: boolean;
|
|
1317
1487
|
email?: string;
|
|
1318
1488
|
info?: UserInfo;
|
|
1319
1489
|
inviteToken?: string;
|
|
@@ -1321,17 +1491,8 @@ export interface SignUpUser {
|
|
|
1321
1491
|
userId?: string;
|
|
1322
1492
|
}
|
|
1323
1493
|
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
*/
|
|
1327
|
-
export interface SingleRide {
|
|
1328
|
-
desiredStartTime?: string;
|
|
1329
|
-
returnTrip?: boolean;
|
|
1330
|
-
}
|
|
1331
|
-
|
|
1332
|
-
export interface SingleRideUpdate {
|
|
1333
|
-
desiredStartTime?: string;
|
|
1334
|
-
rideId?: string;
|
|
1494
|
+
export interface SignedInUser {
|
|
1495
|
+
userId?: string;
|
|
1335
1496
|
}
|
|
1336
1497
|
|
|
1337
1498
|
export interface StopImpersonatingUser {
|
|
@@ -1383,10 +1544,11 @@ export interface TimedPermission {
|
|
|
1383
1544
|
}
|
|
1384
1545
|
|
|
1385
1546
|
export interface Token {
|
|
1386
|
-
|
|
1547
|
+
accountPermissions?: AccountPermission[];
|
|
1387
1548
|
createdBy?: string;
|
|
1388
1549
|
info?: TokenInfo;
|
|
1389
1550
|
lastUpdatedBy?: string;
|
|
1551
|
+
owner?: string;
|
|
1390
1552
|
revoked?: boolean;
|
|
1391
1553
|
tokenId?: string;
|
|
1392
1554
|
}
|
|
@@ -1429,9 +1591,19 @@ export interface UpdateRidePlan extends RideDriverModifyCommand {
|
|
|
1429
1591
|
plannedStartTime?: string;
|
|
1430
1592
|
}
|
|
1431
1593
|
|
|
1432
|
-
export interface UpdateRideSeries extends
|
|
1433
|
-
|
|
1434
|
-
|
|
1594
|
+
export interface UpdateRideSeries extends SeriesCommandWithSeparateEvent {
|
|
1595
|
+
booker?: AccountOrTeamRef;
|
|
1596
|
+
info?: SeriesRideInfo;
|
|
1597
|
+
rideSummaries?: RideSummary[];
|
|
1598
|
+
}
|
|
1599
|
+
|
|
1600
|
+
export interface UpdateRideSeriesEvent extends SeriesBookerCommand {
|
|
1601
|
+
addRides?: string[];
|
|
1602
|
+
booker?: AccountOrTeamRef;
|
|
1603
|
+
cancelRides?: string[];
|
|
1604
|
+
info?: SeriesRideInfo;
|
|
1605
|
+
rideSummaries?: RideSummary[];
|
|
1606
|
+
updateRides?: string[];
|
|
1435
1607
|
}
|
|
1436
1608
|
|
|
1437
1609
|
export interface UpdateTeam extends TeamUpdate {
|
|
@@ -1485,6 +1657,26 @@ export interface UserUpdate extends UserCommand {
|
|
|
1485
1657
|
export interface UserUpdateAfterSignup extends UserUpdate {
|
|
1486
1658
|
}
|
|
1487
1659
|
|
|
1660
|
+
export interface WebsocketFilter {
|
|
1661
|
+
screen: "ride_details" | "fleet_overview" | "hospital_overview" | "marketplace" | "operations_overview";
|
|
1662
|
+
}
|
|
1663
|
+
|
|
1664
|
+
export interface WebsocketMultipleUpdates extends WebsocketUpdate {
|
|
1665
|
+
ridesAndSeries?: RideOrMinimizedSeries[];
|
|
1666
|
+
ridesCount?: RideFilterCount;
|
|
1667
|
+
type: "multiple_updates";
|
|
1668
|
+
}
|
|
1669
|
+
|
|
1670
|
+
export interface WebsocketSingleUpdate extends WebsocketUpdate {
|
|
1671
|
+
id?: string;
|
|
1672
|
+
rideOrSeries?: RideOrMinimizedSeries;
|
|
1673
|
+
type: "single_update";
|
|
1674
|
+
}
|
|
1675
|
+
|
|
1676
|
+
export interface WebsocketUpdate {
|
|
1677
|
+
type: "multiple_updates" | "single_update";
|
|
1678
|
+
}
|
|
1679
|
+
|
|
1488
1680
|
export interface ZonedTimeRange {
|
|
1489
1681
|
end?: Date;
|
|
1490
1682
|
start?: Date;
|
|
@@ -1492,14 +1684,18 @@ export interface ZonedTimeRange {
|
|
|
1492
1684
|
|
|
1493
1685
|
export type AccountRole = "ridebooker" | "dispatcher" | "operator" | "admin" | "owner";
|
|
1494
1686
|
|
|
1495
|
-
export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED";
|
|
1687
|
+
export type AuthenticationResult = "SUCCESS" | "NOT_CONFIRMED" | "ONE_TIME_PASSWORD_NEEDED";
|
|
1496
1688
|
|
|
1497
1689
|
export type BookingStatus = "saved" | "booked" | "accepted" | "planned" | "started" | "completed" | "cancelled";
|
|
1498
1690
|
|
|
1691
|
+
export type DocumentType = "businessLicense" | "publicLiabilityPolicy";
|
|
1692
|
+
|
|
1499
1693
|
export type DrivePermissionFilterUnion = AmbulanceFilter | TaxiFilter;
|
|
1500
1694
|
|
|
1501
1695
|
export type DriveStatus = "driving_to_origin" | "arrived_at_origin" | "driving_to_destination" | "arrived_at_destination" | "completed";
|
|
1502
1696
|
|
|
1697
|
+
export type EntityType = "ride" | "rideseries";
|
|
1698
|
+
|
|
1503
1699
|
export type GeometryUnion = GeoPolygon | GeoMultiPolygon;
|
|
1504
1700
|
|
|
1505
1701
|
export type InsuranceType = "public_insurance" | "private_insurance" | "german_accident_insurance" | "no_or_unknown_insurance";
|
|
@@ -1512,9 +1708,11 @@ export type OrganisationType = "medical" | "fleet" | "operator";
|
|
|
1512
1708
|
|
|
1513
1709
|
export type RidePurpose = "admission" | "relocation" | "discharge" | "consultation";
|
|
1514
1710
|
|
|
1515
|
-
export type
|
|
1711
|
+
export type Screen = "marketplace" | "operations_overview" | "hospital_overview" | "fleet_overview" | "ride_details";
|
|
1712
|
+
|
|
1713
|
+
export type SeriesPurpose = "consultation";
|
|
1516
1714
|
|
|
1517
|
-
export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration";
|
|
1715
|
+
export type Service = "pro_medical" | "pro_fleet" | "pro_operator" | "celios_integration" | "dispolive_integration" | "moxi_operations";
|
|
1518
1716
|
|
|
1519
1717
|
export type SlackChannel = "admin_monitoring" | "admin_respond_immediately" | "admin_respond_within_hour" | "admin_reported_issues";
|
|
1520
1718
|
|
|
@@ -1524,8 +1722,12 @@ export type SyncStatus = "not_synced" | "synced" | "update_not_synced";
|
|
|
1524
1722
|
|
|
1525
1723
|
export type TeamRole = "dispatcher" | "ridebooker";
|
|
1526
1724
|
|
|
1527
|
-
export type TrackingUpdateType = "ride" | "rideseries";
|
|
1528
|
-
|
|
1529
1725
|
export type UserRole = "superadmin";
|
|
1530
1726
|
|
|
1531
1727
|
export type VehicleType = "taxi" | "ambulance";
|
|
1728
|
+
|
|
1729
|
+
export type WebsocketFilterUnion = MarketplaceOverviewFilter | HospitalOverviewFilter | FleetOverviewFilter | OperationsOverviewFilter | DetailsFilter;
|
|
1730
|
+
|
|
1731
|
+
export type WebsocketUpdateType = "single_update" | "multiple_updates";
|
|
1732
|
+
|
|
1733
|
+
export type WebsocketUpdateUnion = WebsocketSingleUpdate | WebsocketMultipleUpdates;
|