@volant-autonomy/via-sdk 1.0.1

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.
@@ -0,0 +1,967 @@
1
+ import createFetcher from './fetch';
2
+ import { bodyOf, queryOf, pathOf, schemas } from './types';
3
+ import type { paths } from './volant-schema';
4
+ type requestOptions = {
5
+ abortKey?: string;
6
+ fetch?: typeof globalThis.fetch;
7
+ };
8
+ export type getAllFlightplans = paths['/flightplans/']['get'];
9
+ export type createDraftFlightplan = paths['/flightplans/']['post'];
10
+ export type modifyDraftFlightplan = paths['/flightplans/{flightplan_id}']['put'];
11
+ export type getFlightplan = paths['/flightplans/{flightplan_id}']['get'];
12
+ export type getFlightplanWaypointsDetailed = paths['/flightplans/{flightplan_id}/waypoints_detail']['get'];
13
+ export type getFlightplanStatistics = paths['/flightplans/{flightplan_id}/statistics']['get'];
14
+ export type getFlightplanVolumes = paths['/flightplans/{flightplan_id}/volumes']['get'];
15
+ export type getFlightplanConflicts = paths['/flightplans/{flightplan_id}/conflicts']['get'];
16
+ export type getFlightplanDeconflictedStartTime = paths['/flightplans/{flightplan_id}/start_time_deconflict']['get'];
17
+ export type changeFlightplanState = paths['/flightplans/{flightplan_id}/state']['post'];
18
+ export type getFlightplanAsFile = paths['/flightplans/{flightplan_id}/content']['get'];
19
+ export type createAirspaceConstraint = paths['/airspace_constraints/']['post'];
20
+ export type getAllAirspaceConstraints = paths['/airspace_constraints/']['get'];
21
+ export type getAirspaceConstraint = paths['/airspace_constraints/{airspace_constraint_id}']['get'];
22
+ export type modifyAirspaceConstraint = paths['/airspace_constraints/{airspace_constraint_id}']['put'];
23
+ export type changeAirspaceConstraintState = paths['/airspace_constraints/{airspace_constraints_id}/state']['post'];
24
+ export type createPathingTask = paths['/pathing_tasks/']['post'];
25
+ export type getPathingTask = paths['/pathing_tasks/{pathing_task_id}']['get'];
26
+ export type getAllAircraft = paths['/aircraft/']['get'];
27
+ export type getAircraft = paths['/aircraft/{aircraft_id}']['get'];
28
+ export type getAllCharts = paths['/charts/']['get'];
29
+ export type getChart = paths['/charts/{chart_id}']['get'];
30
+ export type calculateSailV2_5 = paths['/risk_assessment/sora/v2.5/sail']['get'];
31
+ export type getAllArcsV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications']['get'];
32
+ export type getArcInfoV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications/{arc_id}']['get'];
33
+ export type createSoraReportV2_5 = paths['/risk_assessment/sora/v2.5/report']['post'];
34
+ export type createSoraSemanticModelVolumesV2_5 = paths['/risk_assessment/sora/v2.5/semantic_model_volumes']['post'];
35
+ export type createSoraClassification = paths['/risk_assessment/sora/classifications']['post'];
36
+ export type getSoraClassification = paths['/risk_assessment/sora/classifications/{classification_id}']['get'];
37
+ export type createRasterPattern = paths['/flight_patterns/raster']['post'];
38
+ export declare class Direct {
39
+ private fetcher;
40
+ constructor(fetcher: ReturnType<typeof createFetcher<paths>>);
41
+ /**
42
+ * List Flightplans
43
+ * @description List user's flightplans, including Flightplan ID and state.
44
+ * The most recent 20 flight plans are returned.
45
+ */
46
+ getAllFlightplans<Opts extends requestOptions = {}>(filters?: schemas['AirspaceRestrictionState'][], opts?: Opts | requestOptions): Promise<{
47
+ data?: never;
48
+ error: {
49
+ errors: {
50
+ detail: string;
51
+ status: "401" | "400" | "422";
52
+ }[];
53
+ status: "401" | "400" | "422";
54
+ };
55
+ response: Response;
56
+ aborted: false;
57
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
58
+ data?: never;
59
+ error?: never;
60
+ response?: never;
61
+ aborted: true;
62
+ } : never) | {
63
+ data: {
64
+ id: string;
65
+ type?: "flightplan";
66
+ meta: import("./volant-schema").components["schemas"]["FlightplanMeta"];
67
+ attributes: import("./volant-schema").components["schemas"]["Flightplan-Output"];
68
+ }[];
69
+ error?: never;
70
+ response: Response;
71
+ aborted: false;
72
+ }>;
73
+ /**
74
+ * Create a draft Flightplan
75
+ * @description Create a draft flightplan.
76
+ */
77
+ createDraftFlightplan<Opts extends requestOptions = {}>(args: bodyOf<createDraftFlightplan>, opts?: Opts | requestOptions): Promise<{
78
+ data?: never;
79
+ error: {
80
+ errors: {
81
+ detail: string;
82
+ status: "401" | "400" | "422";
83
+ }[];
84
+ status: "401" | "400" | "422";
85
+ };
86
+ response: Response;
87
+ aborted: false;
88
+ } | (keyof requestOptions & keyof Opts extends never ? never : (requestOptions | Opts)["abortKey"] extends undefined ? never : (requestOptions | Opts)["abortKey"] extends string | undefined ? {
89
+ data?: never;
90
+ error?: never;
91
+ response?: never;
92
+ aborted: true;
93
+ } : never) | {
94
+ data: {
95
+ id: string;
96
+ type?: "flightplan";
97
+ meta: import("./volant-schema").components["schemas"]["FlightplanMeta"];
98
+ attributes: import("./volant-schema").components["schemas"]["Flightplan-Output"];
99
+ };
100
+ error?: never;
101
+ response: Response;
102
+ aborted: false;
103
+ }>;
104
+ /**
105
+ * Modify a Flightplan
106
+ * @description Modify the specified flightplan. This is only permitted while the flightplan state is not
107
+ * `Closed`. If the flightplan is in state: `Accepted`, the flightplan will be subject to conflict
108
+ * checking.
109
+ */
110
+ modifyDraftFlightplan<Opts extends requestOptions = {}>(id: pathOf<modifyDraftFlightplan>['flightplan_id'], args: bodyOf<modifyDraftFlightplan>, opts?: Opts | requestOptions): Promise<{
111
+ data?: never;
112
+ error: {
113
+ errors: {
114
+ detail: string;
115
+ status: "401" | "400" | "422" | "403" | "404";
116
+ }[];
117
+ status: "401" | "400" | "422" | "403" | "404";
118
+ };
119
+ response: Response;
120
+ aborted: false;
121
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
122
+ data?: never;
123
+ error?: never;
124
+ response?: never;
125
+ aborted: true;
126
+ } : never) | {
127
+ data: {
128
+ id: string;
129
+ type?: "flightplan";
130
+ meta: import("./volant-schema").components["schemas"]["FlightplanMeta"];
131
+ attributes: import("./volant-schema").components["schemas"]["Flightplan-Output"];
132
+ };
133
+ error?: never;
134
+ response: Response;
135
+ aborted: false;
136
+ }>;
137
+ /**
138
+ * Retrieve a Flightplan
139
+ * @description Retrieve the specified flightplan
140
+ */
141
+ getFlightplan<Opts extends requestOptions = {}>(id: pathOf<getFlightplan>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
142
+ data?: never;
143
+ error: {
144
+ errors: {
145
+ detail: string;
146
+ status: "401" | "400" | "422" | "404";
147
+ }[];
148
+ status: "401" | "400" | "422" | "404";
149
+ };
150
+ response: Response;
151
+ aborted: false;
152
+ } | (keyof requestOptions & keyof Opts extends never ? never : (requestOptions | Opts)["abortKey"] extends undefined ? never : (requestOptions | Opts)["abortKey"] extends string | undefined ? {
153
+ data?: never;
154
+ error?: never;
155
+ response?: never;
156
+ aborted: true;
157
+ } : never) | {
158
+ data: {
159
+ id: string;
160
+ type?: "flightplan";
161
+ meta: import("./volant-schema").components["schemas"]["FlightplanMeta"];
162
+ attributes: import("./volant-schema").components["schemas"]["Flightplan-Output"];
163
+ };
164
+ error?: never;
165
+ response: Response;
166
+ aborted: false;
167
+ }>;
168
+ /**
169
+ * Retrieve detailed Waypoints
170
+ * @description Retrieve detailed waypoints related to the specified flightplan
171
+ */
172
+ getFlightplanWaypointsDetailed<Opts extends requestOptions = {}>(id: pathOf<getFlightplanWaypointsDetailed>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
173
+ data?: never;
174
+ error: {
175
+ errors: {
176
+ detail: string;
177
+ status: "401" | "400" | "422" | "404";
178
+ }[];
179
+ status: "401" | "400" | "422" | "404";
180
+ };
181
+ response: Response;
182
+ aborted: false;
183
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
184
+ data?: never;
185
+ error?: never;
186
+ response?: never;
187
+ aborted: true;
188
+ } : never) | {
189
+ data: {
190
+ id: string;
191
+ type?: "waypoint_detail";
192
+ attributes: import("./volant-schema").components["schemas"]["WaypointDetailAttributes"];
193
+ };
194
+ error?: never;
195
+ response: Response;
196
+ aborted: false;
197
+ }>;
198
+ /**
199
+ * Retrieve Flightplan Statistics
200
+ * @description Retrieve statistics for the specified flightplan, including the nominal time and cost.
201
+ */
202
+ getFlightplanStatistics<Opts extends requestOptions = {}>(id: pathOf<getFlightplanStatistics>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
203
+ data?: never;
204
+ error: {
205
+ errors: {
206
+ detail: string;
207
+ status: "401" | "400" | "422" | "404";
208
+ }[];
209
+ status: "401" | "400" | "422" | "404";
210
+ };
211
+ response: Response;
212
+ aborted: false;
213
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
214
+ data?: never;
215
+ error?: never;
216
+ response?: never;
217
+ aborted: true;
218
+ } : never) | {
219
+ data: {
220
+ id: string;
221
+ type?: "statistics";
222
+ attributes: import("./volant-schema").components["schemas"]["StatisticsAttributes"];
223
+ };
224
+ error?: never;
225
+ response: Response;
226
+ aborted: false;
227
+ }>;
228
+ /**
229
+ * Retrieve Flightplan Operational Intent Volumes
230
+ * @description Retrieve Operational Intent Volumes for the specified flightplan
231
+ *
232
+ * Volumes wholly contain the operational intent while being as small as practical. Start and end
233
+ * times, as well as lower and upper altitudes, are required for each volume. The end time may not
234
+ * be in the past. Volumes are generated based on the `LateralParameters` of the flightplan about
235
+ * the mean flightpath as defined in each waypoint.
236
+ */
237
+ getFlightplanVolumes<Opts extends requestOptions = {}>(id: pathOf<getFlightplanVolumes>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
238
+ data?: never;
239
+ error: {
240
+ errors: {
241
+ detail: string;
242
+ status: "401" | "400" | "422" | "404";
243
+ }[];
244
+ status: "401" | "400" | "422" | "404";
245
+ };
246
+ response: Response;
247
+ aborted: false;
248
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
249
+ data?: never;
250
+ error?: never;
251
+ response?: never;
252
+ aborted: true;
253
+ } : never) | {
254
+ data: {
255
+ data: import("./volant-schema").components["schemas"]["VolumeResponse"];
256
+ links: import("./volant-schema").components["schemas"]["Links"];
257
+ }[];
258
+ error?: never;
259
+ response: Response;
260
+ aborted: false;
261
+ }>;
262
+ /**
263
+ * Retrieve Flightplan Conflicts
264
+ * @description Retrieve all the conflicts for the specified flightplan, categorised by their state.
265
+ *
266
+ * Flightplans of state `Closed` are ignored.
267
+ *
268
+ * Note that Flightplans which are in the category `Draft` will not prevent transitioning the
269
+ * specified flightplan in to the `Accepted` state and instead are intended as a warning.
270
+ * Flightplans in the `Accepted` state will prevent transition of the specified flightplan to
271
+ * `Accepted`.
272
+ */
273
+ getFlightplanConflicts<Opts extends requestOptions = {}>(id: pathOf<getFlightplanConflicts>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
274
+ data?: never;
275
+ error: {
276
+ errors: {
277
+ detail: string;
278
+ status: "401" | "400" | "422" | "404";
279
+ }[];
280
+ status: "401" | "400" | "422" | "404";
281
+ };
282
+ response: Response;
283
+ aborted: false;
284
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
285
+ data?: never;
286
+ error?: never;
287
+ response?: never;
288
+ aborted: true;
289
+ } : never) | {
290
+ data: {
291
+ data: import("./volant-schema").components["schemas"]["FlightplanConflictResponse"] | import("./volant-schema").components["schemas"]["AirspaceConstraintConflictResponse"];
292
+ links: import("./volant-schema").components["schemas"]["Links"];
293
+ }[];
294
+ error?: never;
295
+ response: Response;
296
+ aborted: false;
297
+ }>;
298
+ /**
299
+ * Returns the inputted flightplan with an updated start time that does not conflict
300
+ * @description Get a new start time for a draft flightplan which will not conflict with any occupied airspace.
301
+ *
302
+ * The flightplan will be delayed up to 10 minutes after the original start time or 10 minutes from
303
+ * the specified start time if provided as a query parameter.
304
+ */
305
+ getFlightplanDeconflictedStartTime<Opts extends requestOptions = {}>(id: pathOf<getFlightplanDeconflictedStartTime>['flightplan_id'], args: queryOf<getFlightplanDeconflictedStartTime>, opts?: Opts | requestOptions): Promise<{
306
+ data?: never;
307
+ error: {
308
+ errors: {
309
+ detail: string;
310
+ status: "401" | "400" | "422" | "404";
311
+ }[];
312
+ status: "401" | "400" | "422" | "404";
313
+ };
314
+ response: Response;
315
+ aborted: false;
316
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
317
+ data?: never;
318
+ error?: never;
319
+ response?: never;
320
+ aborted: true;
321
+ } : never) | {
322
+ data: {
323
+ id: string;
324
+ type?: "flightplan";
325
+ meta: import("./volant-schema").components["schemas"]["FlightplanMeta"];
326
+ attributes: import("./volant-schema").components["schemas"]["Flightplan-Output"];
327
+ };
328
+ error?: never;
329
+ response: Response;
330
+ aborted: false;
331
+ }>;
332
+ /**
333
+ * Change the state of a Flightplan
334
+ * @description Change the state of the specified flightplan
335
+ */
336
+ changeFlightplanState<Opts extends requestOptions = {}>(id: pathOf<changeFlightplanState>['flightplan_id'], state: bodyOf<changeFlightplanState>['state'], opts?: Opts | requestOptions): Promise<{
337
+ data?: never;
338
+ error: {
339
+ errors: {
340
+ detail: string;
341
+ status: "401" | "400" | "422" | "404" | "409";
342
+ }[];
343
+ status: "401" | "400" | "422" | "404" | "409";
344
+ };
345
+ response: Response;
346
+ aborted: false;
347
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
348
+ data?: never;
349
+ error?: never;
350
+ response?: never;
351
+ aborted: true;
352
+ } : never) | {
353
+ data: boolean;
354
+ error?: never;
355
+ response: Response;
356
+ aborted: false;
357
+ }>;
358
+ /**
359
+ * Retrieve a formatted version of a Flightplan
360
+ * @description Retrieve a formatted version of the specified flightplan to download as a file
361
+ */
362
+ getFlightplanAsFile<Opts extends requestOptions = {}>(id: pathOf<getFlightplanAsFile>['flightplan_id'], opts?: Opts | requestOptions): Promise<{
363
+ data?: never;
364
+ error: {
365
+ errors: {
366
+ detail: string;
367
+ status: "401" | "400" | "422" | "404" | "406";
368
+ }[];
369
+ status: "401" | "400" | "422" | "404" | "406";
370
+ };
371
+ response: Response;
372
+ aborted: false;
373
+ } | ("parseAs" | keyof Opts extends never ? never : (Opts & {
374
+ parseAs: "blob";
375
+ })["abortKey"] extends undefined ? never : (Opts & {
376
+ parseAs: "blob";
377
+ })["abortKey"] extends string | undefined ? {
378
+ data?: never;
379
+ error?: never;
380
+ response?: never;
381
+ aborted: true;
382
+ } : never) | {
383
+ data: {
384
+ file: import("openapi-fetch").ParseAsResponse<unknown, Opts & {
385
+ parseAs: "blob";
386
+ }>;
387
+ fileName: string | null;
388
+ };
389
+ error?: never;
390
+ response: Response;
391
+ aborted: false;
392
+ }>;
393
+ /**
394
+ * Create an Airspace Constraint
395
+ * @description Create an airspace constraint.
396
+ */
397
+ createAirspaceConstraint<Opts extends requestOptions = {}>(args: bodyOf<createAirspaceConstraint>, opts?: Opts | requestOptions): Promise<{
398
+ data?: never;
399
+ error: {
400
+ errors: {
401
+ detail: string;
402
+ status: "401" | "400" | "422" | "409";
403
+ }[];
404
+ status: "401" | "400" | "422" | "409";
405
+ };
406
+ response: Response;
407
+ aborted: false;
408
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
409
+ data?: never;
410
+ error?: never;
411
+ response?: never;
412
+ aborted: true;
413
+ } : never) | {
414
+ data: {
415
+ id: string;
416
+ type?: "airspace_constraint";
417
+ meta: import("./volant-schema").components["schemas"]["AirspaceConstraintMeta"];
418
+ attributes: import("./volant-schema").components["schemas"]["AirspaceConstraint-Output"];
419
+ };
420
+ error?: never;
421
+ response: Response;
422
+ aborted: false;
423
+ }>;
424
+ /**
425
+ * List Airspace Constraints
426
+ * @description List Airspace Constraints
427
+ */
428
+ getAllAirspaceConstraints<Opts extends requestOptions = {}>(opts?: Opts | requestOptions): Promise<{
429
+ data?: never;
430
+ error: {
431
+ errors: {
432
+ detail: string;
433
+ status: "401" | "400";
434
+ }[];
435
+ status: "401" | "400";
436
+ };
437
+ response: Response;
438
+ aborted: false;
439
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
440
+ data?: never;
441
+ error?: never;
442
+ response?: never;
443
+ aborted: true;
444
+ } : never) | {
445
+ data: {
446
+ id: string;
447
+ type?: "airspace_constraint";
448
+ meta: import("./volant-schema").components["schemas"]["AirspaceConstraintMeta"];
449
+ attributes: import("./volant-schema").components["schemas"]["AirspaceConstraint-Output"];
450
+ }[];
451
+ error?: never;
452
+ response: Response;
453
+ aborted: false;
454
+ }>;
455
+ /**
456
+ * Retrieve an Airspace Constraint
457
+ * @description Retrieve the specified Airspace Constraint
458
+ */
459
+ getAirspaceConstraint<Opts extends requestOptions = {}>(id: pathOf<getAirspaceConstraint>['airspace_constraint_id'], opts?: Opts | requestOptions): Promise<{
460
+ data?: never;
461
+ error: {
462
+ errors: {
463
+ detail: string;
464
+ status: "401" | "400" | "422" | "404";
465
+ }[];
466
+ status: "401" | "400" | "422" | "404";
467
+ };
468
+ response: Response;
469
+ aborted: false;
470
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
471
+ data?: never;
472
+ error?: never;
473
+ response?: never;
474
+ aborted: true;
475
+ } : never) | {
476
+ data: {
477
+ id: string;
478
+ type?: "airspace_constraint";
479
+ meta: import("./volant-schema").components["schemas"]["AirspaceConstraintMeta"];
480
+ attributes: import("./volant-schema").components["schemas"]["AirspaceConstraint-Output"];
481
+ };
482
+ error?: never;
483
+ response: Response;
484
+ aborted: false;
485
+ }>;
486
+ /**
487
+ * Modify an Airspace Constraint
488
+ * @description Update an airspace constraint.
489
+ */
490
+ modifyAirspaceConstraint<Opts extends requestOptions = {}>(id: pathOf<modifyAirspaceConstraint>['airspace_constraint_id'], args: bodyOf<modifyAirspaceConstraint>, opts?: Opts | requestOptions): Promise<{
491
+ data?: never;
492
+ error: {
493
+ errors: {
494
+ detail: string;
495
+ status: "401" | "400" | "422" | "403" | "404";
496
+ }[];
497
+ status: "401" | "400" | "422" | "403" | "404";
498
+ };
499
+ response: Response;
500
+ aborted: false;
501
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
502
+ data?: never;
503
+ error?: never;
504
+ response?: never;
505
+ aborted: true;
506
+ } : never) | {
507
+ data: {
508
+ id: string;
509
+ type?: "airspace_constraint";
510
+ meta: import("./volant-schema").components["schemas"]["AirspaceConstraintMeta"];
511
+ attributes: import("./volant-schema").components["schemas"]["AirspaceConstraint-Output"];
512
+ };
513
+ error?: never;
514
+ response: Response;
515
+ aborted: false;
516
+ }>;
517
+ /**
518
+ * Change the state of a Airspace Constraint
519
+ * @description Change the state of the specified Airspace Constraint.
520
+ */
521
+ changeAirspaceConstraintState<Opts extends requestOptions = {}>(id: pathOf<changeAirspaceConstraintState>['airspace_constraints_id'], state: bodyOf<changeAirspaceConstraintState>['state'], opts?: Opts | requestOptions): Promise<{
522
+ data?: never;
523
+ error: {
524
+ errors: {
525
+ detail: string;
526
+ status: "401" | "400" | "422" | "404" | "409";
527
+ }[];
528
+ status: "401" | "400" | "422" | "404" | "409";
529
+ };
530
+ response: Response;
531
+ aborted: false;
532
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
533
+ data?: never;
534
+ error?: never;
535
+ response?: never;
536
+ aborted: true;
537
+ } : never) | {
538
+ data: boolean;
539
+ error?: never;
540
+ response: Response;
541
+ aborted: false;
542
+ }>;
543
+ /**
544
+ * Create a Pathing Task
545
+ * @description Create a pathing task that is added to the queue.
546
+ *
547
+ * Generates a risk-minimised route that travels to all checkpoints supplied. The returned task ID
548
+ * can be used to get the status and result.
549
+ */
550
+ createPathingTask<Opts extends requestOptions = {}>(args: bodyOf<createPathingTask>, opts?: Opts | requestOptions): Promise<{
551
+ data?: never;
552
+ error: {
553
+ errors: {
554
+ detail: string;
555
+ status: "401" | "400" | "422";
556
+ }[];
557
+ status: "401" | "400" | "422";
558
+ };
559
+ response: Response;
560
+ aborted: false;
561
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
562
+ data?: never;
563
+ error?: never;
564
+ response?: never;
565
+ aborted: true;
566
+ } : never) | {
567
+ data: {
568
+ id: string;
569
+ type?: "pathing_task";
570
+ attributes?: import("./volant-schema").components["schemas"]["PathingTaskAttributes"] | null;
571
+ meta: import("./volant-schema").components["schemas"]["PathingTaskMeta"];
572
+ };
573
+ error?: never;
574
+ response: Response;
575
+ aborted: false;
576
+ }>;
577
+ /**
578
+ * Retrieve a Pathing Task
579
+ * @description Retrieve the specified Pathing Task.
580
+ *
581
+ * Provides the status of a pathing task. If the task is finished then it will also return the
582
+ * risk minimal and deconflicted route for the flightplan.
583
+ */
584
+ getPathingTask<Opts extends requestOptions = {}>(id: pathOf<getPathingTask>['pathing_task_id'], opts?: Opts | requestOptions): Promise<{
585
+ data?: never;
586
+ error: {
587
+ errors: {
588
+ detail: string;
589
+ status: "401" | "400" | "422" | "404";
590
+ }[];
591
+ status: "401" | "400" | "422" | "404";
592
+ };
593
+ response: Response;
594
+ aborted: false;
595
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
596
+ data?: never;
597
+ error?: never;
598
+ response?: never;
599
+ aborted: true;
600
+ } : never) | {
601
+ data: {
602
+ id: string;
603
+ type?: "pathing_task";
604
+ attributes?: import("./volant-schema").components["schemas"]["PathingTaskAttributes"] | null;
605
+ meta: import("./volant-schema").components["schemas"]["PathingTaskMeta"];
606
+ };
607
+ error?: never;
608
+ response: Response;
609
+ aborted: false;
610
+ }>;
611
+ /**
612
+ * List available aircraft
613
+ * @description List available aircraft.
614
+ */
615
+ getAllAircraft<Opts extends requestOptions = {}>(opts?: Opts | requestOptions): Promise<{
616
+ data?: never;
617
+ error: {
618
+ errors: {
619
+ detail: string;
620
+ status: "401" | "400";
621
+ }[];
622
+ status: "401" | "400";
623
+ };
624
+ response: Response;
625
+ aborted: false;
626
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
627
+ data?: never;
628
+ error?: never;
629
+ response?: never;
630
+ aborted: true;
631
+ } : never) | {
632
+ data: {
633
+ id: string;
634
+ type?: "aircraft";
635
+ attributes: import("./volant-schema").components["schemas"]["AircraftAttributes"];
636
+ }[];
637
+ error?: never;
638
+ response: Response;
639
+ aborted: false;
640
+ }>;
641
+ /**
642
+ * Retrieve the specified aircraft
643
+ * @description Retrieve the specified aircraft.
644
+ */
645
+ getAircraft<Opts extends requestOptions = {}>(id: pathOf<getAircraft>['aircraft_id'], opts?: Opts | requestOptions): Promise<{
646
+ data?: never;
647
+ error: {
648
+ errors: {
649
+ detail: string;
650
+ status: "401" | "400" | "422" | "404";
651
+ }[];
652
+ status: "401" | "400" | "422" | "404";
653
+ };
654
+ response: Response;
655
+ aborted: false;
656
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
657
+ data?: never;
658
+ error?: never;
659
+ response?: never;
660
+ aborted: true;
661
+ } : never) | {
662
+ data: {
663
+ id: string;
664
+ type?: "aircraft";
665
+ attributes: import("./volant-schema").components["schemas"]["AircraftAttributes"];
666
+ };
667
+ error?: never;
668
+ response: Response;
669
+ aborted: false;
670
+ }>;
671
+ /**
672
+ * List all available Charts
673
+ * @description List user's charts, including chart id and bounds.
674
+ */
675
+ getAllCharts<Opts extends requestOptions = {}>(opts?: Opts | requestOptions): Promise<{
676
+ data?: never;
677
+ error: {
678
+ errors: {
679
+ detail: string;
680
+ status: "401" | "400";
681
+ }[];
682
+ status: "401" | "400";
683
+ };
684
+ response: Response;
685
+ aborted: false;
686
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
687
+ data?: never;
688
+ error?: never;
689
+ response?: never;
690
+ aborted: true;
691
+ } : never) | {
692
+ data: {
693
+ id: string;
694
+ type?: "chart";
695
+ attributes: import("./volant-schema").components["schemas"]["ChartAttributes"];
696
+ }[];
697
+ error?: never;
698
+ response: Response;
699
+ aborted: false;
700
+ }>;
701
+ /**
702
+ * Retrieve a specific Chart
703
+ * @description Retrieve a specified Chart
704
+ */
705
+ getChart<Opts extends requestOptions = {}>(id: pathOf<getChart>['chart_id'], opts?: Opts | requestOptions): Promise<{
706
+ data?: never;
707
+ error: {
708
+ errors: {
709
+ detail: string;
710
+ status: "401" | "400" | "422" | "404";
711
+ }[];
712
+ status: "401" | "400" | "422" | "404";
713
+ };
714
+ response: Response;
715
+ aborted: false;
716
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
717
+ data?: never;
718
+ error?: never;
719
+ response?: never;
720
+ aborted: true;
721
+ } : never) | {
722
+ data: {
723
+ id: string;
724
+ type?: "chart";
725
+ attributes: import("./volant-schema").components["schemas"]["ChartAttributes"];
726
+ };
727
+ error?: never;
728
+ response: Response;
729
+ aborted: false;
730
+ }>;
731
+ /**
732
+ * Calculate SAIL
733
+ * @description Calculate Specific Assurance Integrity Level (SAIL).
734
+ */
735
+ calculateSailV2_5<Opts extends requestOptions = {}>(args: queryOf<calculateSailV2_5>, opts?: Opts | requestOptions): Promise<{
736
+ data?: never;
737
+ error: {
738
+ errors: {
739
+ detail: string;
740
+ status: "401" | "400" | "422";
741
+ }[];
742
+ status: "401" | "400" | "422";
743
+ };
744
+ response: Response;
745
+ aborted: false;
746
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
747
+ data?: never;
748
+ error?: never;
749
+ response?: never;
750
+ aborted: true;
751
+ } : never) | {
752
+ data: {
753
+ id: number;
754
+ attributes: import("./volant-schema").components["schemas"]["SailAttributes"];
755
+ };
756
+ error?: never;
757
+ response: Response;
758
+ aborted: false;
759
+ }>;
760
+ /**
761
+ * List available ARCs
762
+ * @description List available ARCs.
763
+ */
764
+ getAllArcsV2_5<Opts extends requestOptions = {}>(opts?: Opts | requestOptions): Promise<{
765
+ data?: never;
766
+ error: {
767
+ errors: {
768
+ detail: string;
769
+ status: "401" | "400";
770
+ }[];
771
+ status: "401" | "400";
772
+ };
773
+ response: Response;
774
+ aborted: false;
775
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
776
+ data?: never;
777
+ error?: never;
778
+ response?: never;
779
+ aborted: true;
780
+ } : never) | {
781
+ data: {
782
+ data: import("./volant-schema").components["schemas"]["ArcResponse"];
783
+ links: import("./volant-schema").components["schemas"]["Links"];
784
+ }[];
785
+ error?: never;
786
+ response: Response;
787
+ aborted: false;
788
+ }>;
789
+ /**
790
+ * Retrieve the specified Air Risk Classification
791
+ * @description Retrieve the specified Air Risk Classification.
792
+ */
793
+ getArcInfoV2_5<Opts extends requestOptions = {}>(args: pathOf<getArcInfoV2_5>, opts?: Opts | requestOptions): Promise<{
794
+ data?: never;
795
+ error: {
796
+ errors: {
797
+ detail: string;
798
+ status: "401" | "400" | "422" | "404";
799
+ }[];
800
+ status: "401" | "400" | "422" | "404";
801
+ };
802
+ response: Response;
803
+ aborted: false;
804
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
805
+ data?: never;
806
+ error?: never;
807
+ response?: never;
808
+ aborted: true;
809
+ } : never) | {
810
+ data: {
811
+ id: import("./volant-schema").components["schemas"]["ARC"];
812
+ name: string;
813
+ implemented: boolean;
814
+ };
815
+ error?: never;
816
+ response: Response;
817
+ aborted: false;
818
+ }>;
819
+ /**
820
+ * Generate a report containing derived SORA information used for regulatory evidence
821
+ * @description Generate a report containing derived SORA information used for regulatory evidence
822
+ */
823
+ createSoraReportV2_5<Opts extends requestOptions = {}>(args: bodyOf<createSoraReportV2_5>, opts?: Opts | requestOptions): Promise<{
824
+ data?: never;
825
+ error: {
826
+ errors: {
827
+ detail: string;
828
+ status: "401" | "400" | "422";
829
+ }[];
830
+ status: "401" | "400" | "422";
831
+ };
832
+ response: Response;
833
+ aborted: false;
834
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
835
+ data?: never;
836
+ error?: never;
837
+ response?: never;
838
+ aborted: true;
839
+ } : never) | {
840
+ data: {
841
+ attributes: import("./volant-schema").components["schemas"]["SoraReportAttributes"];
842
+ type?: "sora_report";
843
+ };
844
+ error?: never;
845
+ response: Response;
846
+ aborted: false;
847
+ }>;
848
+ /**
849
+ * Generate volumes that correspond to the SORA Semantic Model
850
+ * @description Generate volumes that correspond to the SORA Semantic Model
851
+ */
852
+ createSoraSemanticModelVolumesV2_5<Opts extends requestOptions = {}>(args: bodyOf<createSoraSemanticModelVolumesV2_5>, opts?: Opts | requestOptions): Promise<{
853
+ data?: never;
854
+ error: {
855
+ errors: {
856
+ detail: string;
857
+ status: "401" | "400" | "422";
858
+ }[];
859
+ status: "401" | "400" | "422";
860
+ };
861
+ response: Response;
862
+ aborted: false;
863
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
864
+ data?: never;
865
+ error?: never;
866
+ response?: never;
867
+ aborted: true;
868
+ } : never) | {
869
+ data: {
870
+ type: "FeatureCollection";
871
+ features: (import("./volant-schema").components["schemas"]["GeoJsonPolygonFeature_GeoJsonSoraProperties_"] | import("./volant-schema").components["schemas"]["GeoJsonMultiPolygonFeature_GeoJsonSoraProperties_"])[];
872
+ };
873
+ error?: never;
874
+ response: Response;
875
+ aborted: false;
876
+ }>;
877
+ /**
878
+ * Create a SORA Classification
879
+ * @description Create a SORA Classification
880
+ */
881
+ createSoraClassification<Opts extends requestOptions = {}>(args: bodyOf<createSoraClassification>, opts?: Opts | requestOptions): Promise<{
882
+ data?: never;
883
+ error: {
884
+ errors: {
885
+ detail: string;
886
+ status: "401" | "400" | "422" | "404";
887
+ }[];
888
+ status: "401" | "400" | "422" | "404";
889
+ };
890
+ response: Response;
891
+ aborted: false;
892
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
893
+ data?: never;
894
+ error?: never;
895
+ response?: never;
896
+ aborted: true;
897
+ } : never) | {
898
+ data: {
899
+ id: string;
900
+ type?: "sora_classification";
901
+ attributes: import("./volant-schema").components["schemas"]["SoraClassification-Output"];
902
+ };
903
+ error?: never;
904
+ response: Response;
905
+ aborted: false;
906
+ }>;
907
+ /**
908
+ * Get a SORA Classification
909
+ * @description Get a SORA Classification
910
+ */
911
+ getSoraClassification<Opts extends requestOptions = {}>(args: pathOf<getSoraClassification>, opts?: Opts | requestOptions): Promise<{
912
+ data?: never;
913
+ error: {
914
+ errors: {
915
+ detail: string;
916
+ status: "401" | "400" | "422" | "404";
917
+ }[];
918
+ status: "401" | "400" | "422" | "404";
919
+ };
920
+ response: Response;
921
+ aborted: false;
922
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
923
+ data?: never;
924
+ error?: never;
925
+ response?: never;
926
+ aborted: true;
927
+ } : never) | {
928
+ data: {
929
+ id: string;
930
+ type?: "sora_classification";
931
+ attributes: import("./volant-schema").components["schemas"]["SoraClassification-Output"];
932
+ };
933
+ error?: never;
934
+ response: Response;
935
+ aborted: false;
936
+ }>;
937
+ /**
938
+ * Generate a raster pattern
939
+ * @description Generate a raster pattern that covers a specified search polygon
940
+ */
941
+ createRasterPattern<Opts extends requestOptions = {}>(args: bodyOf<createRasterPattern>, opts?: Opts | requestOptions): Promise<{
942
+ data?: never;
943
+ error: {
944
+ errors: {
945
+ detail: string;
946
+ status: "401" | "400" | "422";
947
+ }[];
948
+ status: "401" | "400" | "422";
949
+ };
950
+ response: Response;
951
+ aborted: false;
952
+ } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
953
+ data?: never;
954
+ error?: never;
955
+ response?: never;
956
+ aborted: true;
957
+ } : never) | {
958
+ data: {
959
+ type?: "flight_pattern";
960
+ attributes: import("./volant-schema").components["schemas"]["Raster"];
961
+ };
962
+ error?: never;
963
+ response: Response;
964
+ aborted: false;
965
+ }>;
966
+ }
967
+ export {};