@volant-autonomy/via-sdk 1.3127.1 → 1.3162.1

package/dist/direct.d.ts

@@ -26,13 +26,14 @@ export type getAllAircraft = paths['/aircraft/']['get'];
 export type getAircraft = paths['/aircraft/{aircraft_id}']['get'];
 export type getAllCharts = paths['/charts/']['get'];
 export type getChart = paths['/charts/{chart_id}']['get'];
-export type calculateSailV2_5 = paths['/risk_assessment/sora/v2.5/sail']['get'];
+export type getSailV2_5 = paths['/risk_assessment/sora/v2.5/sail']['get'];
 export type getAllArcsV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications']['get'];
 export type getArcV2_5 = paths['/risk_assessment/sora/v2.5/air_risk_classifications/{arc_id}']['get'];
 export type createSoraReportV2_5 = paths['/risk_assessment/sora/v2.5/report']['post'];
 export type createSoraSemanticModelVolumesV2_5 = paths['/risk_assessment/sora/v2.5/semantic_model_volumes']['post'];
 export type getAllArcsUk = paths['/risk_assessment/sora/uk/air_risk_classifications']['get'];
 export type getArcUk = paths['/risk_assessment/sora/uk/air_risk_classifications/{arc_id}']['get'];
+export type getSailUk = paths['/risk_assessment/sora/uk/sail']['get'];
 export type createSoraSemanticModelVolumesUk = paths['/risk_assessment/sora/uk/semantic_model_volumes']['post'];
 export type createSoraClassification = paths['/risk_assessment/sora/classifications']['post'];
 export type updateSoraClassification = paths['/risk_assessment/sora/classifications/{classification_id}']['put'];
@@ -709,7 +710,7 @@ export declare class Direct {
      * Calculate SAIL
      * @description Calculate Specific Assurance Integrity Level (SAIL).
      */
-    calculateSailV2_5<Opts extends requestOptions = {}>(args: queryOf<calculateSailV2_5>, opts?: Opts | requestOptions): Promise<{
+    getSailV2_5<Opts extends requestOptions = {}>(args: queryOf<getSailV2_5>, opts?: Opts | requestOptions): Promise<{
         data?: never;
         error: {
             errors: {
@@ -727,7 +728,7 @@ export declare class Direct {
         aborted: true;
     } : never) | {
         data: {
-            id: number;
+            id: 0 | 1 | 2 | 3 | 4 | 5 | 6;
             attributes: import("./volant-schema").components["schemas"]["SailAttributes"];
         };
         error?: never;
@@ -918,6 +919,35 @@ export declare class Direct {
         response: Response;
         aborted: false;
     }>;
+    /**
+     * Calculate SAIL
+     * @description Calculate Specific Assurance Integrity Level (SAIL).
+     */
+    getSailUk<Opts extends requestOptions = {}>(args: queryOf<getSailUk>, opts?: Opts | requestOptions): Promise<{
+        data?: never;
+        error: {
+            errors: {
+                detail: string;
+                status: "401" | "400" | "422";
+            }[];
+            status: "401" | "400" | "422";
+        };
+        response: Response;
+        aborted: false;
+    } | (keyof Opts extends never ? never : Opts["abortKey"] extends undefined ? never : Opts["abortKey"] extends string | undefined ? {
+        data?: never;
+        error?: never;
+        response?: never;
+        aborted: true;
+    } : never) | {
+        data: {
+            id: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+            attributes: import("./volant-schema").components["schemas"]["UkSailAttributes"];
+        };
+        error?: never;
+        response: Response;
+        aborted: false;
+    }>;
     /**
      * Generate volumes that correspond to the SORA Semantic Model
      * @description Generate volumes that correspond to the SORA Semantic Model
@@ -971,7 +1001,7 @@ export declare class Direct {
         data: {
             id: string;
             type?: "sora_classification";
-            attributes: import("./volant-schema").components["schemas"]["SoraClassification-Output"];
+            attributes: import("./volant-schema").components["schemas"]["JarusV2_5SoraClassification-Output"] | import("./volant-schema").components["schemas"]["UkSoraClassification-Output"];
         };
         error?: never;
         response: Response;
@@ -1001,7 +1031,7 @@ export declare class Direct {
         data: {
             id: string;
             type?: "sora_classification";
-            attributes: import("./volant-schema").components["schemas"]["SoraClassification-Output"];
+            attributes: import("./volant-schema").components["schemas"]["JarusV2_5SoraClassification-Output"] | import("./volant-schema").components["schemas"]["UkSoraClassification-Output"];
         };
         error?: never;
         response: Response;
@@ -1031,7 +1061,7 @@ export declare class Direct {
         data: {
             id: string;
             type?: "sora_classification";
-            attributes: import("./volant-schema").components["schemas"]["SoraClassification-Output"];
+            attributes: import("./volant-schema").components["schemas"]["JarusV2_5SoraClassification-Output"] | import("./volant-schema").components["schemas"]["UkSoraClassification-Output"];
         };
         error?: never;
         response: Response;

package/dist/direct.js

@@ -214,8 +214,7 @@ class Direct {
         });
     }
     /// risk assessment
-    // TODO rename to get
-    calculateSailV2_5(args, opts) {
+    getSailV2_5(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.GET('/risk_assessment/sora/v2.5/sail', { query: args }, opts);
             if (resp.error === undefined && !resp.aborted) {
@@ -278,6 +277,15 @@ class Direct {
             return resp;
         });
     }
+    getSailUk(args, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.fetcher.GET('/risk_assessment/sora/uk/sail', { query: args }, opts);
+            if (resp.error === undefined && !resp.aborted) {
+                return Object.assign(Object.assign({}, resp), { data: resp.data.data });
+            }
+            return resp;
+        });
+    }
     createSoraSemanticModelVolumesUk(args, opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.fetcher.POST('/risk_assessment/sora/uk/semantic_model_volumes', { body: args }, opts);

package/dist/volant-schema.d.ts

@@ -612,6 +612,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/risk_assessment/sora/uk/sail": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Calculate SAIL
+         * @description Calculate Specific Assurance Integrity Level (SAIL).
+         */
+        get: operations["uk_sail_v1_risk_assessment_sora_uk_sail_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/risk_assessment/sora/uk/air_risk_classifications": {
         parameters: {
             query?: never;
@@ -1058,41 +1078,6 @@ export interface components {
             type?: "chart";
             attributes: components["schemas"]["ChartAttributes"];
         };
-        /** Classification */
-        Classification: {
-            /**
-             * Final GRC Determination
-             * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
-             * @enum {integer}
-             */
-            final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
-            /** Residual Arc */
-            residual_arc: components["schemas"]["ARC"][];
-            mitigations: components["schemas"]["Mitigations"];
-            /**
-             * Ground Risk Buffer
-             * @description The ground risk buffer is an                 area on the ground that surrounds the footprint of the contingency volume. It is                 expected that if the flight exits the contingency volume during a loss of control                 of the operation that the flight will be terminated within this lateral distance.
-             */
-            ground_risk_buffer: number;
-            /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM             coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest             value present in any of the cells of the source grid it intersects.             The values are normalised by source data cell area to derive a density value of people per square metre. */
-            population_density_source: components["schemas"]["PopulationSource"];
-            /** Controlled Ground Area Id */
-            controlled_ground_area_id?: string | null;
-            /** Atypical Airspace Id */
-            atypical_airspace_id?: string | null;
-            /** @default {
-             *       "max_cruise_speed": 20,
-             *       "characteristic_dimension": 0.5
-             *     } */
-            aircraft?: components["schemas"]["Aircraft"];
-            /**
-             * Containment Robustness
-             * @description Level of technical and operational mitigations intended to contain the flight of the UA within the defined operational volume and ground risk buffer.
-             * @default low
-             * @enum {string}
-             */
-            containment_robustness?: "low" | "medium" | "high";
-        };
         /**
          * ContainmentRequirements
          * @description The containment requirements ensure that the target level of safety can be met for both ground and air risk in the
@@ -1541,6 +1526,61 @@ export interface components {
          * @enum {integer}
          */
         IntrinsicGRC: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+        /** JarusV2_5ClassificationPayload */
+        JarusV2_5ClassificationPayload: {
+            /**
+             * Final GRC Determination
+             * @description The Final GRC determination, based on the availability and correct application of mitigations to the operation after determination of the intrinsic GRC.
+             * @enum {integer}
+             */
+            final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+            /** Residual Arc */
+            residual_arc: components["schemas"]["ARC"][];
+            mitigations: components["schemas"]["Mitigations"];
+            /**
+             * Ground Risk Buffer
+             * @description The ground risk buffer is an                 area on the ground that surrounds the footprint of the contingency volume. It is                 expected that if the flight exits the contingency volume during a loss of control                 of the operation that the flight will be terminated within this lateral distance.
+             */
+            ground_risk_buffer: number;
+            /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM             coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest             value present in any of the cells of the source grid it intersects.             The values are normalised by source data cell area to derive a density value of people per square metre. */
+            population_density_source: components["schemas"]["PopulationSource"];
+            /** Controlled Ground Area Id */
+            controlled_ground_area_id?: string | null;
+            /** Atypical Airspace Id */
+            atypical_airspace_id?: string | null;
+            /** @default {
+             *       "max_cruise_speed": 20,
+             *       "characteristic_dimension": 0.5
+             *     } */
+            aircraft?: components["schemas"]["Aircraft"];
+            /**
+             * Containment Robustness
+             * @description Level of technical and operational mitigations intended to contain the flight of the UA within the defined operational volume and ground risk buffer.
+             * @default low
+             * @enum {string}
+             */
+            containment_robustness?: "low" | "medium" | "high";
+        };
+        /** JarusV2_5SoraClassification */
+        "JarusV2_5SoraClassification-Input": {
+            /**
+             * Implementation
+             * @constant
+             * @enum {string}
+             */
+            implementation: "jarus_v2.5";
+            payload: components["schemas"]["JarusV2_5ClassificationPayload"];
+        };
+        /** JarusV2_5SoraClassification */
+        "JarusV2_5SoraClassification-Output": {
+            /**
+             * Implementation
+             * @constant
+             * @enum {string}
+             */
+            implementation: "jarus_v2.5";
+            payload: components["schemas"]["JarusV2_5ClassificationPayload"];
+        };
         /** JsonApiException */
         JsonApiException: {
             /**
@@ -1688,6 +1728,11 @@ export interface components {
             data: components["schemas"]["UkArcResponse"];
             links: components["schemas"]["Links"];
         };
+        /** JsonApiResponse[UkSailResponse] */
+        JsonApiResponse_UkSailResponse_: {
+            data: components["schemas"]["UkSailResponse"];
+            links: components["schemas"]["Links"];
+        };
         /** JsonApiResponse[VolumeResponse] */
         JsonApiResponse_VolumeResponse_: {
             data: components["schemas"]["VolumeResponse"];
@@ -1995,8 +2040,12 @@ export interface components {
         };
         /** SailResponse */
         SailResponse: {
-            /** Id */
-            id: number;
+            /**
+             * Id
+             * @description Unique integer representation of the SAIL
+             * @enum {integer}
+             */
+            id: 0 | 1 | 2 | 3 | 4 | 5 | 6;
             attributes: components["schemas"]["SailAttributes"];
         };
         /** SemanticModelProperties */
@@ -2008,18 +2057,6 @@ export interface components {
              */
             name: "Flight Geography" | "Contingency Buffer" | "Ground Risk Buffer" | "Adjacent Area";
         };
-        /** SoraClassification */
-        "SoraClassification-Input": {
-            /** @description The implementation of SORA that is described by `payload` */
-            implementation: components["schemas"]["SoraImplementation"];
-            payload: components["schemas"]["Classification"];
-        };
-        /** SoraClassification */
-        "SoraClassification-Output": {
-            /** @description The implementation of SORA that is described by `payload` */
-            implementation: components["schemas"]["SoraImplementation"];
-            payload: components["schemas"]["Classification"];
-        };
         /** SoraClassificationResponse */
         SoraClassificationResponse: {
             /**
@@ -2035,14 +2072,9 @@ export interface components {
              * @enum {string}
              */
             type?: "sora_classification";
-            attributes: components["schemas"]["SoraClassification-Output"];
+            /** Attributes */
+            attributes: components["schemas"]["JarusV2_5SoraClassification-Output"] | components["schemas"]["UkSoraClassification-Output"];
         };
-        /**
-         * SoraImplementation
-         * @constant
-         * @enum {string}
-         */
-        SoraImplementation: "jarus_v2.5";
         /** SoraReportAttributes */
         SoraReportAttributes: {
             /**
@@ -2411,6 +2443,87 @@ export interface components {
             type?: "air_risk_classification";
             attributes: components["schemas"]["UkArcAttributes"];
         };
+        /** UkClassificationPayload */
+        UkClassificationPayload: {
+            /**
+             * Final GRC Determination
+             * @description The Final GRC determination, based on the availability and correct application of mitigations to         the operation after determination of the intrinsic GRC.
+             * @enum {integer}
+             */
+            final_grc: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+            /** Residual Arc */
+            residual_arc: ("arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-d1" | "arc-d2")[];
+            mitigations: components["schemas"]["UkMitigations"];
+            /**
+             * Ground Risk Buffer
+             * @description The ground risk buffer is an                 area on the ground that surrounds the footprint of the contingency volume. It is                 expected that if the flight exits the contingency volume during a loss of control                 of the operation that the flight will be terminated within this lateral distance.
+             */
+            ground_risk_buffer: number;
+            /** @description Population Density Data Source. Data has been re-projected and resampled to a square grid in UTM             coordinates to work in the context of VIA's services. The value in each cell of the grid is the largest             value present in any of the cells of the source grid it intersects.             The values are normalised by source data cell area to derive a density value of people per square metre. */
+            population_density_source: components["schemas"]["PopulationSource"];
+            /** Controlled Ground Area Id */
+            controlled_ground_area_id?: string | null;
+            /** Atypical Airspace Id */
+            atypical_airspace_id?: string | null;
+            /** @default {
+             *       "max_cruise_speed": 20,
+             *       "characteristic_dimension": 0.5
+             *     } */
+            aircraft?: components["schemas"]["Aircraft"];
+            /**
+             * Containment Robustness
+             * @description Level of technical and operational mitigations intended to contain the flight of the UA within the defined operational volume and ground risk buffer.
+             * @default low
+             * @enum {string}
+             */
+            containment_robustness?: "low" | "medium" | "high";
+        };
+        /** UkMitigations */
+        UkMitigations: {
+            /**
+             * Mitigation 1(A)
+             * @description Strategic mitigations for ground risk.
+             * @enum {string}
+             */
+            m1a: "none" | "low" | "medium";
+            /**
+             * Mitigation 1(B)
+             * @description Visual Line of Sight (VLOS) - avoid flying over people
+             * @enum {string}
+             */
+            m1b: "none" | "medium" | "high";
+            /**
+             * Mitigation 1(C)
+             * @description Tactical Mitigations - Ground observation
+             * @enum {string}
+             */
+            m1c: "none" | "low";
+            /**
+             * Mitigation 2
+             * @description Efforts to reduce UA impact dynamics
+             * @enum {string}
+             */
+            m2: "none" | "medium" | "high";
+        };
+        /** UkSailAttributes */
+        UkSailAttributes: {
+            /**
+             * SAIL
+             * @description The SAIL represents the level of confidence that the UAS operation will stay under control.
+             * @enum {string}
+             */
+            sail: "NA" | "I" | "II" | "III" | "IV" | "V" | "VI" | "VII";
+        };
+        /** UkSailResponse */
+        UkSailResponse: {
+            /**
+             * Id
+             * @description Unique integer representation of the SAIL
+             * @enum {integer}
+             */
+            id: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+            attributes: components["schemas"]["UkSailAttributes"];
+        };
         /** UkSemanticModelVolumesRequest */
         UkSemanticModelVolumesRequest: {
             /**
@@ -2439,6 +2552,26 @@ export interface components {
              */
             ground_risk_buffer: number;
         };
+        /** UkSoraClassification */
+        "UkSoraClassification-Input": {
+            /**
+             * Implementation
+             * @constant
+             * @enum {string}
+             */
+            implementation: "uk";
+            payload: components["schemas"]["UkClassificationPayload"];
+        };
+        /** UkSoraClassification */
+        "UkSoraClassification-Output": {
+            /**
+             * Implementation
+             * @constant
+             * @enum {string}
+             */
+            implementation: "uk";
+            payload: components["schemas"]["UkClassificationPayload"];
+        };
         /** ValidationError */
         ValidationError: {
             /** Location */
@@ -4812,6 +4945,89 @@ export interface operations {
             };
         };
     };
+    uk_sail_v1_risk_assessment_sora_uk_sail_get: {
+        parameters: {
+            query: {
+                /** @description The Final GRC determination, based on the availability and correct application of mitigations to         the operation after determination of the intrinsic GRC. */
+                final_grc: number;
+                /**
+                 * @description Qualitative classification of the air environment.
+                 *
+                 *             - 'arc-a1' - ARC-a (NMAC Encounter Rate)
+                 *
+                 *             - 'arc-a2' - ARC-a (Linear Infrastructure)
+                 *
+                 *             - 'arc-a3' - ARC-a (Restricted Airspace)
+                 *
+                 *             - 'arc-a4' - ARC-a (Danger Area)
+                 *
+                 *             - 'arc-a5' - ARC-a (Self Declared)
+                 *
+                 *             - 'arc-b1' - ARC-b (Class C or D Airspace <500ft AGL)
+                 *
+                 *             - 'arc-c1' - ARC-c (Class E or G Airspace)
+                 *
+                 *             - 'arc-c2' - ARC-c (Class C or D Airspace in area with Visual Flight Rules)
+                 *
+                 *             - 'arc-c3' - ARC-c (Class C or D Airspace in area with Low-Level Helicopter Route)
+                 *
+                 *             - 'arc-c4' - ARC-c (Class C or D Airspace >500ft AGL)
+                 *
+                 *             - 'arc-d1' - ARC-d (Class A Airspace)
+                 *
+                 *             - 'arc-d2' - ARC-d (Class C or D Airspace in area with known Instrument Flight Procedures)
+                 *
+                 * @example [
+                 *       "arc-b1",
+                 *       "arc-c4"
+                 *     ]
+                 */
+                arc: ("arc-a1" | "arc-a2" | "arc-a3" | "arc-a4" | "arc-a5" | "arc-b1" | "arc-c1" | "arc-c2" | "arc-c3" | "arc-c4" | "arc-d1" | "arc-d2")[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiResponse_UkSailResponse_"];
+                };
+            };
+            /** @description One or more input parameters were missing or invalid. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiExceptionResponse"];
+                };
+            };
+            /** @description Bearer access token was not provided in Authorization header, token could not         be decoded, or token was invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsonApiExceptionResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     uk_ARCs_list_v1_risk_assessment_sora_uk_air_risk_classifications_get: {
         parameters: {
             query?: never;
@@ -4994,7 +5210,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["SoraClassification-Input"];
+                "application/json": components["schemas"]["JarusV2_5SoraClassification-Input"] | components["schemas"]["UkSoraClassification-Input"];
             };
         };
         responses: {
@@ -5116,7 +5332,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["SoraClassification-Input"];
+                "application/json": components["schemas"]["JarusV2_5SoraClassification-Input"] | components["schemas"]["UkSoraClassification-Input"];
             };
         };
         responses: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volant-autonomy/via-sdk",
-  "version": "1.3127.1",
+  "version": "1.3162.1",
   "license": "MIT",
   "source": "src/index.ts",
   "types": "dist/index.d.ts",