@volant-autonomy/via-sdk 1.4837.1 → 1.4861.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.
package/dist/direct.d.ts CHANGED
@@ -132,8 +132,10 @@ export declare class Direct {
132
132
  }>;
133
133
  /**
134
134
  * Modify a Flightplan
135
- * @description Modify the specified flightplan. This is only permitted while the flightplan state is not `Closed`. If the
136
- * flightplan is in state: `Accepted`, the flightplan will be subject to conflict checking.
135
+ * @description Modify the specified flightplan.
136
+ *
137
+ * This is only permitted while the flightplan state is not `Closed`. If the flightplan is in state: `Accepted`, the
138
+ * flightplan will be subject to conflict checking.
137
139
  */
138
140
  modifyDraftFlightplan<Opts extends requestOptions = {}>(id: pathOf<modifyDraftFlightplan>['flightplan_id'], args: bodyOf<modifyDraftFlightplan>, opts?: Opts | requestOptions): Promise<{
139
141
  data?: never;
@@ -971,8 +973,9 @@ export declare class Direct {
971
973
  }>;
972
974
  /**
973
975
  * Calculate Residual ARC
974
- * @description Calculate the Residual ARC accounting for any strategic air risk mitigations. The Residual ARC is determined as
975
- * the "worst case".
976
+ * @description Calculate the Residual ARC accounting for any strategic air risk mitigations.
977
+ *
978
+ * NOTE: The Residual ARC is determined as the "worst case".
976
979
  */
977
980
  calculateResidualArcUk<Opts extends requestOptions = {}>(args: bodyOf<calculateResidualArcUk>, opts?: Opts | requestOptions): Promise<{
978
981
  data?: never;
@@ -1231,8 +1234,9 @@ export declare class Direct {
1231
1234
  }>;
1232
1235
  /**
1233
1236
  * Update a Controlled Ground Area
1234
- * @description Modify an existing Controlled Ground Area. This cannot be performed when it is referenced by a flightplan in state
1235
- * `Accepted`.
1237
+ * @description Modify an existing Controlled Ground Area.
1238
+ *
1239
+ * NOTE: This cannot be performed when it is referenced by a flightplan in state `Accepted`.
1236
1240
  */
1237
1241
  updateControlledGroundArea<Opts extends requestOptions = {}>(id: pathOf<updateControlledGroundArea>['controlled_ground_area_id'], args: bodyOf<updateControlledGroundArea>, opts?: Opts | requestOptions): Promise<{
1238
1242
  data?: never;
@@ -1380,8 +1384,9 @@ export declare class Direct {
1380
1384
  }>;
1381
1385
  /**
1382
1386
  * Update an Atypical Airspace
1383
- * @description Modify an existing Atypical Airspace. This cannot be performed when it is referenced by a flightplan in state
1384
- * `Accepted`.
1387
+ * @description Modify an existing Atypical Airspace.
1388
+ *
1389
+ * NOTE: This cannot be performed when it is referenced by a flightplan in state `Accepted`.
1385
1390
  */
1386
1391
  updateAtypicalAirspace<Opts extends requestOptions = {}>(id: pathOf<updateAtypicalAirspace>['atypical_airspace_id'], args: bodyOf<updateAtypicalAirspace>, opts?: Opts | requestOptions): Promise<{
1387
1392
  data?: never;
package/dist/index.cjs.js CHANGED
@@ -758,7 +758,7 @@ function defaultPathSerializer(pathname, pathParams) {
758
758
  return nextURL;
759
759
  }
760
760
 
761
- var version = "1.4837.1";
761
+ var version = "1.4861.1";
762
762
 
763
763
  const querySerializer = createQuerySerializer();
764
764
  class Fetcher {
package/dist/index.esm.js CHANGED
@@ -756,7 +756,7 @@ function defaultPathSerializer(pathname, pathParams) {
756
756
  return nextURL;
757
757
  }
758
758
 
759
- var version = "1.4837.1";
759
+ var version = "1.4861.1";
760
760
 
761
761
  const querySerializer = createQuerySerializer();
762
762
  class Fetcher {
@@ -61,8 +61,10 @@ export interface paths {
61
61
  get: operations["flightplan_single_v1_flightplans__flightplan_id__get"];
62
62
  /**
63
63
  * Modify a Flightplan
64
- * @description Modify the specified flightplan. This is only permitted while the flightplan state is not `Closed`. If the
65
- * flightplan is in state: `Accepted`, the flightplan will be subject to conflict checking.
64
+ * @description Modify the specified flightplan.
65
+ *
66
+ * This is only permitted while the flightplan state is not `Closed`. If the flightplan is in state: `Accepted`, the
67
+ * flightplan will be subject to conflict checking.
66
68
  */
67
69
  put: operations["flightplan_replace_v1_flightplans__flightplan_id__put"];
68
70
  post?: never;
@@ -436,8 +438,9 @@ export interface paths {
436
438
  get: operations["get_controlled_ground_area_v1_risk_assessment_sora_controlled_ground_areas__controlled_ground_area_id__get"];
437
439
  /**
438
440
  * Update a Controlled Ground Area
439
- * @description Modify an existing Controlled Ground Area. This cannot be performed when it is referenced by a flightplan in state
440
- * `Accepted`.
441
+ * @description Modify an existing Controlled Ground Area.
442
+ *
443
+ * NOTE: This cannot be performed when it is referenced by a flightplan in state `Accepted`.
441
444
  */
442
445
  put: operations["update_controlled_ground_area_v1_risk_assessment_sora_controlled_ground_areas__controlled_ground_area_id__put"];
443
446
  post?: never;
@@ -491,8 +494,9 @@ export interface paths {
491
494
  get: operations["get_atypical_airspace_v1_risk_assessment_sora_atypical_airspaces__atypical_airspace_id__get"];
492
495
  /**
493
496
  * Update an Atypical Airspace
494
- * @description Modify an existing Atypical Airspace. This cannot be performed when it is referenced by a flightplan in state
495
- * `Accepted`.
497
+ * @description Modify an existing Atypical Airspace.
498
+ *
499
+ * NOTE: This cannot be performed when it is referenced by a flightplan in state `Accepted`.
496
500
  */
497
501
  put: operations["update_atypical_airspace_v1_risk_assessment_sora_atypical_airspaces__atypical_airspace_id__put"];
498
502
  post?: never;
@@ -644,8 +648,9 @@ export interface paths {
644
648
  put?: never;
645
649
  /**
646
650
  * Calculate Residual ARC
647
- * @description Calculate the Residual ARC accounting for any strategic air risk mitigations. The Residual ARC is determined as
648
- * the "worst case".
651
+ * @description Calculate the Residual ARC accounting for any strategic air risk mitigations.
652
+ *
653
+ * NOTE: The Residual ARC is determined as the "worst case".
649
654
  */
650
655
  post: operations["uk_residual_arc_v1_risk_assessment_sora_uk_residual_arc_post"];
651
656
  delete?: never;
@@ -950,9 +955,10 @@ export interface components {
950
955
  };
951
956
  /**
952
957
  * AglAlgorithmCorridor
953
- * @description Corridor to apply to pathing operation. The result will be guaranteed to be within these bounds if a valid result
954
- * can be found. If AMSL is used, then a conservative approximation will be used over the region which may result in
955
- * being overly-restrictive.
958
+ * @description Corridor to apply to pathing operation.
959
+ *
960
+ * The result will be guaranteed to be within these bounds if a valid result can be found. If AMSL is used, then a
961
+ * conservative approximation will be used over the region which may result in being overly-restrictive.
956
962
  */
957
963
  AglAlgorithmCorridor: {
958
964
  ceiling?: components["schemas"]["Altitude-Input"] | null;
@@ -2223,6 +2229,11 @@ export interface components {
2223
2229
  /**
2224
2230
  * Geocage
2225
2231
  * @description An area that the operation must be contained within.
2232
+ *
2233
+ * If the supplied Feature Collection has a feature that is invalid, due to self-intersections or otherwise malformed
2234
+ * geometry, an attempt will be made to fix it. During this process, any collapsed geometries will be discarded and
2235
+ * composite types decomposed into Polygon types, this may mean that the resulting returned payload is different to
2236
+ * the original request.
2226
2237
  * @example {
2227
2238
  * "features": [
2228
2239
  * {
@@ -2281,6 +2292,11 @@ export interface components {
2281
2292
  /**
2282
2293
  * Geocage
2283
2294
  * @description An area that the operation must be contained within.
2295
+ *
2296
+ * If the supplied Feature Collection has a feature that is invalid, due to self-intersections or otherwise malformed
2297
+ * geometry, an attempt will be made to fix it. During this process, any collapsed geometries will be discarded and
2298
+ * composite types decomposed into Polygon types, this may mean that the resulting returned payload is different to
2299
+ * the original request.
2284
2300
  * @example {
2285
2301
  * "features": [
2286
2302
  * {
@@ -2423,10 +2439,11 @@ export interface components {
2423
2439
  };
2424
2440
  /**
2425
2441
  * GotoWaypoint
2426
- * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters`. All parameters
2427
- * are defined as to be used during the leg flying towards this waypoint.
2442
+ * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters`.
2443
+ *
2444
+ * All parameters are defined as to be used during the leg flying towards this waypoint.
2428
2445
  *
2429
- * Note that the `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
2446
+ * NOTE: The `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
2430
2447
  */
2431
2448
  "GotoWaypoint-Input": {
2432
2449
  /**
@@ -2444,10 +2461,11 @@ export interface components {
2444
2461
  };
2445
2462
  /**
2446
2463
  * GotoWaypoint
2447
- * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters`. All parameters
2448
- * are defined as to be used during the leg flying towards this waypoint.
2464
+ * @description Fly to a specified location under given `flight_parameters` accounting for given `wind_parameters`.
2465
+ *
2466
+ * All parameters are defined as to be used during the leg flying towards this waypoint.
2449
2467
  *
2450
- * Note that the `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
2468
+ * NOTE: The `speed` provided in `wind_parameters` must be less than the `airspeed` provided in `flight_parameters`
2451
2469
  */
2452
2470
  "GotoWaypoint-Output": {
2453
2471
  /**
@@ -3222,8 +3240,9 @@ export interface components {
3222
3240
  };
3223
3241
  /**
3224
3242
  * PathingTaskResponse
3225
- * @description Standard response for pathing task GET endpoint. The attributes with waypoints are included in the response if the
3226
- * state is "successful".
3243
+ * @description Standard response for pathing task GET endpoint.
3244
+ *
3245
+ * The attributes with waypoints are included in the response if the state is "successful".
3227
3246
  */
3228
3247
  PathingTaskResponse: {
3229
3248
  /**
@@ -3249,12 +3268,13 @@ export interface components {
3249
3268
  PathingTaskState: "queued" | "in-progress" | "successful" | "failed";
3250
3269
  /**
3251
3270
  * Polygon
3252
- * @description An enclosed area on the earth. The bounding edges of this polygon are defined to be the shortest paths between
3253
- * connected vertices. This means, for instance, that the edge between two points both defined at a particular latitude
3254
- * is not generally contained at that latitude. The winding order must be interpreted as the order which produces the
3255
- * smaller area. The path between two vertices is defined to be the shortest possible path between those vertices.
3256
- * Edges may not cross. Vertices may not be duplicated. In particular, the final polygon vertex must not be identical
3257
- * to the first vertex.
3271
+ * @description An enclosed area on the earth.
3272
+ *
3273
+ * The bounding edges of this polygon are defined to be the shortest paths between connected vertices. This means, for
3274
+ * instance, that the edge between two points both defined at a particular latitude is not generally contained at that
3275
+ * latitude. The winding order must be interpreted as the order which produces the smaller area. The path between two
3276
+ * vertices is defined to be the shortest possible path between those vertices. Edges may not cross. Vertices may not
3277
+ * be duplicated. In particular, the final polygon vertex must not be identical to the first vertex.
3258
3278
  */
3259
3279
  Polygon: {
3260
3280
  /** Vertices */
@@ -3267,8 +3287,10 @@ export interface components {
3267
3287
  PopulationSource: "GHS_2020_R2023_100" | "EUROSTAT_2021_R2024_1000" | "EIDC_residential_2011_R2017_1000" | "EIDC_workday_2011_R2017_1000" | "ONS_EW_2021_R2021_1000" | "ONS_EW_2021_R2021_200" | "ONS_EW_2021_R2021_100" | "ONS_EW_WORKDAY_2021_R2021_1000" | "ONS_EW_WORKDAY_2021_R2021_200" | "ONS_EW_WORKDAY_2021_R2021_100" | "ONS_EW_OT_2021_R2021_1000" | "ONS_EW_OT_2021_R2021_200" | "ONS_EW_OT_2021_R2021_100";
3268
3288
  /**
3269
3289
  * ProfileAttributes
3270
- * @description Profile of specified data across the Flightplan. Data is zipped by index such that each array has the same length
3271
- * and a given index corresponding to the appropriate data in each array.
3290
+ * @description Profile of specified data across the Flightplan.
3291
+ *
3292
+ * Data is zipped by index such that each array has the same length and a given index corresponding to the appropriate
3293
+ * data in each array.
3272
3294
  */
3273
3295
  ProfileAttributes: {
3274
3296
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volant-autonomy/via-sdk",
3
- "version": "1.4837.1",
3
+ "version": "1.4861.1",
4
4
  "license": "MIT",
5
5
  "source": "src/index.ts",
6
6
  "types": "dist/index.d.ts",