-
Notifications
You must be signed in to change notification settings - Fork 20
/
index.d.ts
1750 lines (1711 loc) · 51.9 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
/** Type helpers */
type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
export interface paths {
"/v1/me": {
/**
* User profile
* @description Returns information about the authenticated user
*/
get: operations["getProfile"];
};
"/v1/me/devices": {
/**
* Device list
* @description List devices owned or readable by authenticated user
*/
get: operations["getDevices"];
};
"/v1/{dongleId}/devices": {
/**
* List devices (superuser)
* @description List devices owned or readable by specified user
*/
get: operations["getUserDevices"];
};
"/v1.1/devices/{dongleId}": {
/**
* Device details
* @description Returns information about the specified device
*/
get: operations["getDevice"];
};
"/v1/devices/{dongleId}": {
/** Update device alias */
patch: operations["updateDevice"];
};
"/v1/devices/{dongleId}/location": {
/** Device location */
get: operations["getDeviceLocation"];
};
"/v1/devices/{dongleId}/pair": {
/**
* Pair device
* @description Pair a device to a user's account.
*/
post: operations["pairDeviceToUser"];
};
"/v1/devices/{dongleId}/unpair": {
/**
* Unpair device
* @description Unpair device from authenticated user's account. Any comma prime subscription linked to the device will be cancelled.
*/
post: operations["unpairDevice"];
};
"/v1/devices/{dongleId}/owner": {
/**
* Device owner
* @description Returns the owner of a device.
*/
get: operations["getDeviceOwner"];
};
"/v1/devices/{dongleId}/users": {
/**
* Device users
* @description List users with access to a device
*/
get: operations["getDeviceUsers"];
};
"/v1/devices/{dongleId}/add_user": {
/**
* Grant device access
* @description Grant read permissions to a user by email. Authed user must be device owner to perform. If multiple users are attached to an email address, device access is granted to all users.
*/
post: operations["addDeviceUser"];
};
"/v1/devices/{dongleId}/del_user": {
/**
* Revoke device access
* @description Revoke read permissions from a user by email. Authed user must be device owner to perform. If multiple users are attached to an email address, device access is removed from all users.
*/
post: operations["revokeDeviceUser"];
};
"/v1.1/devices/{dongleId}/stats": {
/**
* Device driving statistics
* @description Returns aggregate driving statistics for a device over the past 7 days and all time.
*/
get: operations["getDeviceStatistics"];
};
"/v1/devices/{dongleId}/bootlogs": {
/**
* Device boot logs
* @description Retrieve boot logs uploaded from a device.
*/
get: operations["getDeviceBootLogs"];
};
"/v1/devices/{dongleId}/crashlogs": {
/**
* Device crash logs
* @description Retrieve crash logs uploaded from a device.
*/
get: operations["getDeviceCrashLogs"];
};
"/v1/devices/{dongleId}/routes": {
/**
* Device routes
* @description Returns a list of routes uploaded from a device.
*/
get: operations["getDeviceRoutes"];
};
"/v1/devices/{dongleId}/routes/preserved": {
/**
* Device preserved routes
* @description Returns a list of preserved routes uploaded from a device.
*/
get: operations["getDevicePreservedRoutes"];
};
"/v1/devices/{dongleId}/routes_segments": {
/**
* Device routes segments
* @description Returns a list of route segments uploaded from a device between a start and end timestamp.
*/
get: operations["getDeviceRoutesSegments"];
};
"/v1/devices/{dongleId}/segments": {
/**
* Device segments
* @description Returns time-sorted list of segments, each of which includes basic metadata derived from openpilot logs.
*/
get: operations["getDeviceSegments"];
};
"/{dongleId}": {
/**
* Submit Athena payload
* @description Send JSON-RPC requests to the active websocket connection for a given device, identified by its dongle ID.
*
* Some method types support offline queueing of messages until the device comes online (see `expiry`). The
* response will indicate whether the message was queued or not.
*/
post: operations["submitAthenaPayload"];
};
"/v1/devices/{dongleId}/athena_offline_queue": {
/**
* Athena offline queue
* @description Return a list of queued payloads for delivery to device when it is online.
*/
get: operations["getDeviceAthenaOfflineQueue"];
};
"/v1.4/{dongleId}/upload_url": {
/**
* Log file upload
* @description Request a URL to which an openpilot file an be uploaded via HTTP PUT. This endpoint only accepts tokens signed with a device private key.
*/
get: operations["getUploadUrl"];
};
"/v1/{dongleId}/upload_urls": {
/**
* Batch log file upload
* @description Request URLs to which openpilot files can be uploaded via HTTP PUT. This endpoint only accepts tokens signed with a device private key.
*/
post: operations["getUploadUrls"];
};
"/v2/pilotpair": {
/**
* Pair device
* @description Pair a device to the authenticated user's account.
*/
post: operations["pilotPair"];
};
"/v2/pilotauth": {
/** Authenticate device (openpilot) */
post: operations["pilotAuth"];
};
"/v1/route/{routeName}": {
/**
* Route details
* @description Returns information about the specified route. Authenticated user must have ownership of, or read access to, the device from which the route was uploaded.
*/
get: operations["getRoute"];
/**
* Update route
* @description Update route metadata. Authenticated user must have ownership of the device from which the route was uploaded.
*/
patch: operations["updateRoute"];
};
"/v1/route/{routeName}/segments": {
/**
* Route segments
* @description Returns list of segments comprising a route. Authenticated user must have ownership of, or read access to, the device from which the route was uploaded.
*/
get: operations["getRouteSegments"];
};
"/v1/route/{routeName}/files": {
/**
* Raw log files
* @description Retrieve uploaded files for a route. Calls to this API are rate limited to 5 per minute.
*/
get: operations["getRouteFiles"];
};
"/v1/route/{routeName}/qcamera.m3u8": {
/**
* Route HLS stream
* @description Returns rear camera HLS stream index of MPEG-TS fragments.
*/
get: operations["getRouteStream"];
};
"/v1/route/{routeName}/share_signature": {
/**
* Route sharing signature
* @description Return route share URL signature. Expires in 365 days.
*/
get: operations["getRouteShareSignature"];
};
"/v1/route/{routeName}/preserve": {
/**
* Preserve route
* @description Preserve route from deletion. Authenticated user must have ownership of the device from which the route was uploaded.
*/
post: operations["preserveRoute"];
/**
* Unpreserve route
* @description Unpreserve route from deletion. Authenticated user must have ownership of the device from which the route was uploaded.
*/
delete: operations["unpreserveRoute"];
};
"/v1/tokens/mapbox/{dongleId}": {
/**
* Mapbox token
* @description Returns a Mapbox token for the specified dongle ID. Authenticated user must have ownership of the dongle ID.
*/
get: operations["getMapboxToken"];
};
"/v1/navigation/{dongleId}/set_destination": {
/**
* Set nav destination
* @description Set destination for navigation. Authenticated user must have ownership of the dongle ID.
*/
post: operations["setDestination"];
};
"/v1/navigation/{dongleId}/next": {
/**
* Get nav destination
* @description Retrieve next location from database. This was set on Set destination if the device was offline. Next location is removed from the database after this call or when a new destination is set.
*/
get: operations["getNavigationNext"];
/**
* Clear nav destination
* @description Delete next destination from database.
*/
delete: operations["clearNavigationNext"];
};
"/v1/navigation/{dongleId}/locations": {
/**
* Saved locations
* @description Retrieve saved locations from database.
*/
get: operations["getNavigationSavedLocations"];
/** Save location */
put: operations["saveNavigationLocation"];
/** Delete location */
delete: operations["deleteNavigationLocation"];
/** Update location */
patch: operations["updateNavigationLocation"];
};
"/v1/clips/create": {
/**
* Create clip
* @description Create a clip from a route.
*/
post: operations["createClip"];
};
"/v1/clips/list": {
/**
* List clips
* @description List clips created for the specified device.
*/
get: operations["getClips"];
};
"/v1/clips/details": {
/** Get clip details */
get: operations["getClip"];
};
"/v1/clips/update": {
/** Delete clip */
delete: operations["deleteClip"];
/** Update clip */
patch: operations["updateClip"];
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
Profile: {
/**
* Format: email
* @description Email address
* @example commaphone3@gmail.com
*/
email: string;
/**
* @description Dongle ID
* @example 2e9eeac96ea4e6a6
*/
id: string;
/**
* @deprecated
* @description comma points
* @example 34933
*/
points: number;
/**
* @description Unix timestamp at time of registration
* @example 1465103707
*/
regdate: number;
/**
* @description <a href="https://comma.ai/jobs">Apply for superuser here</a>
* @example false
*/
superuser: boolean;
/**
* @deprecated
* @description Username
* @example joeyjoejoe
*/
username?: string | null;
/**
* @description OAuth2 user ID
* @example google_111803823964622526972
*/
user_id: string;
};
Device: {
dongle_id: components["schemas"]["DongleID"];
/** @description Device nickname */
alias: string;
/** @description Device serial number */
serial: string;
/** @description Last connected athena server hostname */
athena_host?: string | null;
/** @description Unix timestamp of last athena ping */
last_athena_ping?: number;
/** @description Uploads are ignored from this device */
ignore_uploads?: boolean | null;
/** @description Device has an owner */
is_paired: boolean;
/** @description Authenticated user has write-access to the device */
is_owner?: boolean;
/** @description 2048-bit public RSA key */
public_key: string | null;
/** @description Device has a prime subscription */
prime: boolean;
/**
* @description Prime subscription type
* - 0 = None
* - 1 = Magenta
* - 2 = Lite
* - 3 = Blue
* - 4 = Magenta New
*
* @enum {number}
*/
prime_type: 0 | 1 | 2 | 3 | 4;
/** @description Device prime trial is claimed */
trial_claimed: boolean | null;
/**
* @description Device type
* @enum {string}
*/
device_type: "app" | "neo" | "panda" | "two" | "freon" | "pc" | "three";
/** @description Unix timestamp, in milliseconds */
last_gps_time: number | null;
/** @description Latitude, in decimal degrees */
last_gps_lat: number | null;
/** @description Longitude, in decimal degrees */
last_gps_lng: number | null;
/** @description Accuracy, in metres */
last_gps_accuracy: number | null;
/** @description Speed, in metres per second */
last_gps_speed: number | null;
/** @description Direction angle, in degrees from north */
last_gps_bearing: number | null;
/** @description openpilot version */
openpilot_version?: string | null;
/** @description Last known SIM ID of the device */
sim_id: string | null;
};
DeviceUser: {
/** @description User email */
email: string;
permission: components["schemas"]["DeviceUserPermission"];
};
/**
* @description Device user permission
* @enum {string}
*/
DeviceUserPermission: "read_access" | "owner";
DeviceLocation: {
/** @description Latitude, in decimal degrees */
lat: number;
/** @description Longitude, in decimal degrees */
lng: number;
/** @description Unix timestamp, in milliseconds */
time: number;
/** @description Accuracy, in metres */
accuracy: number;
/** @description Speed, in metres per second */
speed: number;
/** @description Direction angle, in degrees from north */
bearing: number;
};
/** @description Summary of drives over a period of time */
DrivingStatistics: {
/** @description Sum of distance driven in time period, in miles */
distance: number;
/** @description Sum of time driven in time period, in minutes */
minutes: number;
/** @description Count of routes in time period */
routes: number;
};
/** @description A single segment of a route is up to 60 seconds in length. */
Segment: {
canonical_name: components["schemas"]["SegmentName"];
/** @description Segment number */
number: number;
canonical_route_name: components["schemas"]["RouteName"];
dongle_id: components["schemas"]["DongleID"];
/** @description Unix timestamp at which upload_url was first called for file in segment */
create_time: number;
/** @description Segment start time, milliseconds since epoch */
start_time_utc_millis: number;
/** @description Segment end time, milliseconds since epoch */
end_time_utc_millis: number;
/** @description Signed URL from which route.coords and JPEGs can be downloaded */
url: string;
/** @description Sum of distances between GPS points in miles */
length: number;
/** @description Segment contains CAN messages */
can: boolean;
/** @description Segment has ublox packets */
hpgps: boolean;
/** @description Segment contains radar tracks in CAN */
radar: boolean;
devicetype: components["schemas"]["SegmentDataSource"];
proc_log: components["schemas"]["FileProcStatus"];
proc_qlog: components["schemas"]["FileProcStatus"];
proc_camera: components["schemas"]["FileProcStatus"];
proc_dcamera: components["schemas"]["FileProcStatus"];
/** @description openpilot is running in passive mode */
passive: boolean;
/** @description openpilot version */
version: string;
/** @description git commit hash */
git_commit: string;
/** @description git branch */
git_branch: string;
/** @description git remote url */
git_remote: string;
/** @description git working tree is dirty */
git_dirty: boolean;
};
Route: {
fullname: components["schemas"]["RouteName"];
dongle_id: components["schemas"]["DongleID"];
user_id: components["schemas"]["DongleID"];
/** @description Route is publicly accessible */
is_public?: boolean;
/** @description Unix timestamp at which upload_url was first called for file in route */
create_time: number;
/** @description Signed storage bucket URL from which route.coords and JPEGs can be downloaded */
url: string;
/** @description Unix timestamp at which signed URL expires */
share_expiry: number;
/** @description URL signature */
share_sig: string;
/** @description Sum of distances between GPS points in miles */
length: number;
/** @description Route contains CAN messages */
can?: boolean;
/** @description Route has ublox packets */
hpgps?: boolean;
/** @description Route contains radar tracks in CAN */
radar?: boolean;
devicetype: components["schemas"]["SegmentDataSource"];
/** @description Maximum qlog segment number uploaded */
maxqlog?: number;
/** @description Maximum qcamera segment number uploaded */
maxqcamera?: number;
/** @description Maximum log segment number uploaded */
maxlog: number;
/** @description Maximum road camera segment number uploaded */
maxcamera: number;
/** @description Maximum driver camera segment number uploaded */
maxdcamera: number;
/** @description Maximum wide road camera segment number uploaded */
maxecamera?: number;
/** @description Maximum qlog segment number processed */
procqlog?: number;
/** @description Maximum qcamera segment number processed */
procqcamera?: number;
/** @description Maximum log segment number processed */
proclog: number;
/** @description Maximum road camera segment number processed */
proccamera: number;
/** @description First latitude recorded in route from GPS */
start_lat?: number;
/** @description First longitude recorded in route from GPS */
start_lng?: number;
/** @description Unix timestamp at beginning of route */
start_time: number;
/** @description Last latitude recorded in route from GPS */
end_lat?: number;
/** @description Last longitude recorded in route from GPS */
end_lng?: number;
/** @description Unix timestamp at end of last segment in route */
end_time: number;
/** @description openpilot is running in passive mode */
passive?: boolean;
/** @description openpilot version */
version?: string;
/** @description git commit hash */
git_commit?: string;
/** @description git branch */
git_branch?: string;
/** @description git remote url */
git_remote?: string;
/** @description git working tree is dirty */
git_dirty?: boolean;
/** @description openpilot platform name */
platform?: string;
vin?: components["schemas"]["VIN"];
/** @description Minimum logMonoTime from openpilot log */
init_logmonotime?: number;
};
RouteSegment: components["schemas"]["Route"] & {
/** @description Segment numbers in route */
segment_numbers: (number)[];
/** @description Segment start times in milliseconds since epoch */
segment_start_times: (number)[];
/** @description Segment end times in milliseconds since epoch */
segment_end_times: (number)[];
};
/**
* @description Device type
* @enum {string}
*/
DeviceType: "app" | "neo" | "panda" | "two" | "freon" | "pc" | "three";
/**
* @description Data source
* - 3 = eon
* - 6 = comma two
* - 7 = comma three
*
* @enum {integer}
*/
SegmentDataSource: 3 | 6 | 7;
/**
* @description Log file status
* - -1 = Not received
* - 0 = Upload URL sent
* - 10 = Received
* - 20 = Enqueued
* - 30 = Processing
* - 40 = Processed
* - 50 = Errored
*
* @enum {integer}
*/
FileProcStatus: -1 | 0 | 10 | 20 | 30 | 40 | 50;
/**
* @description File type
* 1. Road camera (fcamera)
* 2. Driver camera (dcamera)
* 3. Raw log (rlog)
* 4. Qlog
* 5. QCamera
* 6. Wide road camera (extended, ecamera)
*
* @enum {integer}
*/
FileType: 1 | 2 | 3 | 4 | 5 | 6;
/**
* Dongle ID
* @description A unique 16-character hexadecimal string. Can represent a device or a user.
* @example 1a2b3c4d5e6f7a8b
*/
readonly DongleID: string;
/**
* Canonical route name
* @description Contains a dongle ID and timestamp of the beginning of the route
* @example 1a2b3c4d5e6f7a8b|2019-01-01--00-00-00
*/
RouteName: string;
/**
* Canonical segment name
* @description Contains a dongle ID, timestamp of the beginning of the route, and segment number
* @example 1a2b3c4d5e6f7a8b|2019-01-01--00-00-00--0
*/
SegmentName: string;
/**
* Vehicle identification number
* @description 17-character alphanumeric string
* @example 5YJ3E1EA7HF000000
*/
VIN: string;
/** Navigation destination */
NavigationDestination: {
/**
* @description Short name of destination
* @example 1441 State St
*/
place_name: string;
/**
* @description Address details of destination. Should not include short name.
* @example San Diego, CA 92101, United States
*/
place_details: string;
/**
* @description Latitude, decimal degrees
* @example 32.72045
*/
latitude: number;
/**
* @description Longitude, decimal degrees
* @example -117.16621
*/
longitude: number;
};
/**
* Navigation saved location ID
* @description Identifier for a saved location
*/
NavigationSavedLocationID: number;
/** Navigation saved location */
NavigationSavedLocation: ({
id: components["schemas"]["NavigationSavedLocationID"];
dongle_id: components["schemas"]["DongleID"];
save_type: components["schemas"]["NavigationLocationType"];
/** @description Optional label for locations with type "favorite" */
label?: string | null;
/** @description When this saved location was last modified */
modified: string;
}) & components["schemas"]["NavigationDestination"];
/**
* @description Navigation location type
* @enum {string}
*/
NavigationLocationType: "favorite" | "recent";
/**
* Clip ID
* @description Unique identifier for a clip
*/
readonly ClipID: number;
ClipProperties: {
id: components["schemas"]["ClipID"];
/**
* @description Unix timestamp when clip was created, in milliseconds
* @example 1670109391000
*/
create_time: number;
dongle_id: components["schemas"]["DongleID"];
route_name: components["schemas"]["RouteName"];
/** @description Unix timestamp when clip starts, in milliseconds */
start_time: number;
/** @description Unix timestamp when clip ends, in milliseconds */
end_time: number;
/** @description Optional title for clip */
title?: string | null;
/**
* @description - `q` = QCamera
* - `f` = Road camera
* - `e` = Wide road camera
* - `d` = Driver camera
* - `360` = 360 video
*
* @enum {string}
*/
video_type: "q" | "f" | "e" | "d" | "360";
/** @description Clip is publicly accessible */
is_public?: boolean;
};
/** Pending Clip */
PendingClip: components["schemas"]["ClipProperties"] & ({
/** @enum {string} */
status?: "pending";
/**
* @description Pending clip status
* @example processing
* @enum {string}
*/
pending_status?: "waiting_jobs" | "processing";
/**
* @description Processing progress, from 0 to 1
* @example 0.5
*/
pending_progress?: number;
});
/** Done Clip */
DoneClip: components["schemas"]["ClipProperties"] & {
/** @enum {string} */
status?: "done";
/** @description URL to clip */
url?: string;
/** @description URL to clip thumbnail */
thumbnail?: string;
};
/** Failed Clip */
FailedClip: components["schemas"]["ClipProperties"] & ({
/** @enum {string} */
status?: "failed";
/**
* @description Error message
* @example upload_failed
* @enum {string}
*/
error_status?: "upload_failed_request" | "upload_failed" | "upload_failed_dcam" | "upload_timed_out" | "export_failed";
});
/** @description Video clip created from part of a route */
Clip: components["schemas"]["PendingClip"] | components["schemas"]["DoneClip"] | components["schemas"]["FailedClip"];
JSONRPCPayload: {
/** @description JSON-RPC method name */
method: string;
/**
* @description JSON-RPC version
* @enum {string}
*/
jsonrpc: "2.0";
/**
* @description JSON-RPC request ID
* @enum {integer}
*/
id: 0;
};
JSONRPCResponse: {
/**
* @description JSON-RPC version
* @enum {string}
*/
jsonrpc: "2.0";
/**
* @description JSON-RPC request ID
* @enum {integer}
*/
id: 0;
/** @description Method-specific result */
result?: Record<string, never>;
};
GetMessageMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getMessage";
params: {
/**
* @description service name
* @example peripheralState
*/
service: string;
/**
* @description time to wait for a message in milliseconds
* @example 5000
*/
timeout?: number;
};
};
GetVersionMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getVersion";
};
SetNavDestinationMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "setNavDestination";
params: components["schemas"]["NavigationDestination"];
};
RebootMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "reboot";
};
UploadFilesToUrlsMethod: components["schemas"]["JSONRPCPayload"] & ({
/** @enum {string} */
method?: "uploadFilesToUrls";
params: ({
fn: string;
url: string;
/**
* @default {}
* @example {
* "x-ms-blob-type": "BlockBlob"
* }
*/
headers?: {
[key: string]: string | undefined;
};
/** @default false */
allow_cellular?: boolean;
})[];
/**
* @description Unix timestamp at which this message will be removed from the offline queue, after
* which it will no longer be sent to the device if it comes online. If not specified,
* this message will not be added to the offline queue.
*/
expiry?: number;
});
ListUploadQueueMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "listUploadQueue";
};
GetPublicKeyMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getPublicKey";
};
GetSshAuthorizedKeysMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getSshAuthorizedKeys";
};
GetSimInfoMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getSimInfo";
};
GetNetworkTypeMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getNetworkType";
};
GetNetworkMeteredMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getNetworkMetered";
};
GetNetworksMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "getNetworks";
};
TakeSnapshotMethod: components["schemas"]["JSONRPCPayload"] & {
/** @enum {string} */
method?: "takeSnapshot";
};
AthenaPayload: components["schemas"]["GetMessageMethod"] | components["schemas"]["GetVersionMethod"] | components["schemas"]["SetNavDestinationMethod"] | components["schemas"]["RebootMethod"] | components["schemas"]["UploadFilesToUrlsMethod"] | components["schemas"]["ListUploadQueueMethod"] | components["schemas"]["GetPublicKeyMethod"] | components["schemas"]["GetSshAuthorizedKeysMethod"] | components["schemas"]["GetSimInfoMethod"] | components["schemas"]["GetNetworkTypeMethod"] | components["schemas"]["GetNetworkMeteredMethod"] | components["schemas"]["GetNetworksMethod"] | components["schemas"]["TakeSnapshotMethod"];
/**
* @example {
* "jsonrpc": "2.0",
* "id": 0,
* "result": {
* "success": 1
* }
* }
*/
AthenaResponse: components["schemas"]["JSONRPCResponse"];
};
responses: {
/** @description Operation successful */
SuccessInteger: {
content: {
"application/json": {
/** @constant */
success: 1;
};
};
};
/** @description Operation successful */
SuccessBoolean: {
content: {
"application/json": {
/** @constant */
success: true;
};
};
};
};
parameters: {
/** @description Dongle ID */
dongleId: components["schemas"]["DongleID"];
/** @description Canonical route name */
routeName: components["schemas"]["RouteName"];
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type external = Record<string, never>;
export interface operations {
getProfile: {
/**
* User profile
* @description Returns information about the authenticated user
*/
responses: {
/** @description JSON object containing the user's profile information */
200: {
content: {
"application/json": components["schemas"]["Profile"];
};
};
};
};
getDevices: {
/**
* Device list
* @description List devices owned or readable by authenticated user
*/
responses: {
/** @description JSON array of device objects */
200: {
content: {
"application/json": (components["schemas"]["Device"])[];
};
};
};
};
getUserDevices: {
/**
* List devices (superuser)
* @description List devices owned or readable by specified user
*/
responses: {
/** @description JSON array of device objects */
200: {
content: {
"application/json": (components["schemas"]["Device"])[];
};
};
};
};
getDevice: {
/**
* Device details
* @description Returns information about the specified device
*/
responses: {
/** @description JSON object containing the device's information */
200: {
content: {
"application/json": components["schemas"]["Device"];
};
};
};
};
updateDevice: {
/** Update device alias */
requestBody?: {
content: {
"application/json": {
alias: string;
};
};
};
responses: {
/** @description JSON object containing the updated device's information */
200: {
content: {
"application/json": components["schemas"]["Device"];
};
};
};
};
getDeviceLocation: {
/** Device location */
responses: {
/** @description JSON object containing device location, or an error message if the location is not known. */
200: {