@esri/arcgis-rest-elevation 1.0.0

package/dist/esm/findElevationAtManyPoints.js

@@ -0,0 +1,43 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl } from "./utils.js";
+/**
+ * This method returns elevations in meters at given longitudes and latitudes
+ * within the WGS84 coordinate system. The order of the points returned by this
+ * request will be the same as the order of the points passed in the coordinates
+ * parameter.
+ *
+ * If the distance between the furthest West and furthest East coordinate or
+ * the furthest North and furthest South coordinate exceeds 50km, the service
+ * will return a 400 HTTP response as the distance between these points is too
+ * large.
+ *
+ * By default the elevation is measured with respect to the Earth's mean sea level.
+ * It takes into account the local variations in gravity and provides a consistent
+ * vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtManyPoints } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtManyPoints({
+ *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+export function findElevationAtManyPoints(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["relativeTo"], Object.assign({}, requestOptions));
+    options.params.coordinates = JSON.stringify(requestOptions.coordinates);
+    return request(`${baseUrl}/elevation/at-many-points`, Object.assign({}, options)).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+//# sourceMappingURL=findElevationAtManyPoints.js.map

package/dist/esm/findElevationAtManyPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findElevationAtManyPoints.js","sourceRoot":"","sources":["../../src/findElevationAtManyPoints.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAyBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,yBAAyB,CACvC,cAAiD;IAEjD,MAAM,OAAO,GAAQ,kBAAkB,CACrC,cAAc,EACd,CAAC,YAAY,CAAC,oBAET,cAAc,EAEpB,CAAC;IAEF,OAAO,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAExE,OACE,OAAO,CAAC,GAAG,OAAO,2BAA2B,oBACxC,OAAO,EAEb,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtManyPointsPost\"][\"requestBody\"][\"content\"][\"application/json\"],\n  \"coordinates\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtManyPointsPost\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtManyPointsResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtManyPointsOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns elevations in meters at given longitudes and latitudes\n * within the WGS84 coordinate system. The order of the points returned by this\n * request will be the same as the order of the points passed in the coordinates\n * parameter.\n *\n * If the distance between the furthest West and furthest East coordinate or\n * the furthest North and furthest South coordinate exceeds 50km, the service\n * will return a 400 HTTP response as the distance between these points is too\n * large.\n *\n * By default the elevation is measured with respect to the Earth's mean sea level.\n * It takes into account the local variations in gravity and provides a consistent\n * vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtManyPoints } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtManyPoints({\n *   coordinates: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]],\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtManyPoints(\n  requestOptions: IFindElevationAtManyPointsOptions\n): Promise<IFindElevationAtManyPointsResponse> {\n  const options: any = appendCustomParams<IFindElevationAtManyPointsOptions>(\n    requestOptions,\n    [\"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  options.params.coordinates = JSON.stringify(requestOptions.coordinates);\n\n  return (\n    request(`${baseUrl}/elevation/at-many-points`, {\n      ...options\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtManyPointsResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"]}

package/dist/esm/findElevationAtPoint.d.ts

@@ -0,0 +1,40 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { operations } from "./openapi-types.js";
+declare type queryParams = Pick<operations["ElevationAtPointGet"]["parameters"]["query"], "lon" | "lat" | "relativeTo">;
+declare type successResponse = operations["ElevationAtPointGet"]["responses"]["200"]["content"]["application/json"];
+/**
+ * The response format for {@linkcode findElevationAtPoint};
+ */
+export interface IFindElevationAtPointResponse extends successResponse {
+}
+/**
+ * Options for {@linkcode findElevationAtPoint}.
+ */
+export interface IFindElevationAtPointOptions extends Omit<IRequestOptions, "httpMethod" | "f">, queryParams {
+}
+/**
+ * This method returns the elevation in meters at a given longitude and latitude
+ * within the WGS84 coordinate system. By default the elevation is measured with
+ * respect to the Earth's mean sea level. It takes into account the local
+ * variations in gravity and provides a consistent vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtPoint({
+ *   lon: -179.99,
+ *   lat: -85.05,
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+export declare function findElevationAtPoint(requestOptions: IFindElevationAtPointOptions): Promise<IFindElevationAtPointResponse>;
+export {};

package/dist/esm/findElevationAtPoint.js

@@ -0,0 +1,34 @@
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { baseUrl } from "./utils.js";
+/**
+ * This method returns the elevation in meters at a given longitude and latitude
+ * within the WGS84 coordinate system. By default the elevation is measured with
+ * respect to the Earth's mean sea level. It takes into account the local
+ * variations in gravity and provides a consistent vertical reference.
+ *
+ * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be
+ * measured with respect to the ellipsoid. This is a mathematical model that
+ * approximates the shape of the Earth. It does not consider local variations
+ * in gravity and is commonly used in GPS positioning.
+ *
+ * ```
+ * import { findElevationAtPoint } from "@esri/arcgis-rest-elevation";
+ * import { ApiKeyManager } from "@esri/arcgis-rest-request";
+ *
+ * const results = await findElevationAtPoint({
+ *   lon: -179.99,
+ *   lat: -85.05,
+ *   authentication: ApiKeyManager.fromKey("YOUR_ACCESS_TOKEN");
+ * });
+ *
+ * console.log(results)
+ * ```
+ */
+export function findElevationAtPoint(requestOptions) {
+    const options = appendCustomParams(requestOptions, ["lon", "lat", "relativeTo"], Object.assign({}, requestOptions));
+    return request(`${baseUrl}/elevation/at-point`, Object.assign(Object.assign({}, options), { httpMethod: "GET" })).then((response) => {
+        const r = Object.assign({}, response);
+        return r;
+    });
+}
+//# sourceMappingURL=findElevationAtPoint.js.map

package/dist/esm/findElevationAtPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findElevationAtPoint.js","sourceRoot":"","sources":["../../src/findElevationAtPoint.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAyBrC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,oBAAoB,CAClC,cAA4C;IAE5C,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,oBAEvB,cAAc,EAEpB,CAAC;IAEF,OACE,OAAO,CAAC,GAAG,OAAO,qBAAqB,kCAClC,OAAO,KACV,UAAU,EAAE,KAAK,IAEpB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,MAAM,CAAC,qBACF,QAAQ,CACZ,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  request,\n  appendCustomParams,\n  IRequestOptions\n} from \"@esri/arcgis-rest-request\";\n\nimport { operations } from \"./openapi-types.js\";\nimport { baseUrl } from \"./utils.js\";\n\n// determine the list of allowed params we want to allow as options\n// this should match the array given to appendCustomParams below\ntype queryParams = Pick<\n  operations[\"ElevationAtPointGet\"][\"parameters\"][\"query\"],\n  \"lon\" | \"lat\" | \"relativeTo\"\n>;\n\n// get the correct type of the response format\ntype successResponse =\n  operations[\"ElevationAtPointGet\"][\"responses\"][\"200\"][\"content\"][\"application/json\"];\n\n/**\n * The response format for {@linkcode findElevationAtPoint};\n */\nexport interface IFindElevationAtPointResponse extends successResponse {}\n\n/**\n * Options for {@linkcode findElevationAtPoint}.\n */\nexport interface IFindElevationAtPointOptions\n  extends Omit<IRequestOptions, \"httpMethod\" | \"f\">,\n    queryParams {}\n\n/**\n * This method returns the elevation in meters at a given longitude and latitude\n * within the WGS84 coordinate system. By default the elevation is measured with\n * respect to the Earth's mean sea level. It takes into account the local\n * variations in gravity and provides a consistent vertical reference.\n *\n * If the relativeTo query parameter is set to `ellipsoid`, the elevation will be\n * measured with respect to the ellipsoid. This is a mathematical model that\n * approximates the shape of the Earth. It does not consider local variations\n * in gravity and is commonly used in GPS positioning.\n *\n * ```\n * import { findElevationAtPoint } from \"@esri/arcgis-rest-elevation\";\n * import { ApiKeyManager } from \"@esri/arcgis-rest-request\";\n *\n * const results = await findElevationAtPoint({\n *   lon: -179.99,\n *   lat: -85.05,\n *   authentication: ApiKeyManager.fromKey(\"YOUR_ACCESS_TOKEN\");\n * });\n *\n * console.log(results)\n * ```\n */\nexport function findElevationAtPoint(\n  requestOptions: IFindElevationAtPointOptions\n): Promise<IFindElevationAtPointResponse> {\n  const options = appendCustomParams<IFindElevationAtPointOptions>(\n    requestOptions,\n    [\"lon\", \"lat\", \"relativeTo\"],\n    {\n      ...requestOptions\n    }\n  );\n\n  return (\n    request(`${baseUrl}/elevation/at-point`, {\n      ...options,\n      httpMethod: \"GET\"\n    }) as Promise<successResponse>\n  ).then((response) => {\n    const r: IFindElevationAtPointResponse = {\n      ...response\n    };\n\n    return r;\n  });\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export type {} from "@esri/arcgis-rest-request";
+export * from "./findElevationAtPoint.js";
+export * from "./findElevationAtManyPoints.js";

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+export * from "./findElevationAtPoint.js";
+export * from "./findElevationAtManyPoints.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;gBACgB;AAMhB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\n// Types that are used in this package are re-exported for convenience and\n// to make the links work correctly in the documentation pages.\nexport type {} from \"@esri/arcgis-rest-request\";\n\nexport * from \"./findElevationAtPoint.js\";\nexport * from \"./findElevationAtManyPoints.js\";\n"]}

package/dist/esm/openapi-types.d.ts

@@ -0,0 +1,473 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/elevation/at-point": {
+        /**
+         * Returns the elevation in meters at a given longitude and latitude within the WGS84 coordinate system.
+         *
+         * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+         *
+         * If the `relativeTo` query parameter is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+         *
+         * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
+         */
+        get: operations["ElevationAtPointGet"];
+    };
+    "/elevation/at-many-points": {
+        /**
+         * Returns elevations in meters at given longitudes and latitudes within the WGS84 coordinate system.
+         *
+         * The order of the points returned by this request will be the same as the order of the points passed in the
+         * `coordinates` parameter.
+         *
+         * If the distance between the furthest West and furthest East coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.
+         *
+         * If the distance between the furthest North and furthest South coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.
+         *
+         * If any of the points are otherwise invalid, a `400` HTTP response will be returned.
+         *
+         * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+         *
+         * If the `relativeTo` parameter in the body is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+         *
+         * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
+         *
+         * The Post Body content type must be either:
+         * - JSON with content type of `application/json`, or
+         * - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`.
+         *
+         * The following parameters are used to fetch elevations for multiple coordinates:
+         *
+         * **coordinates**
+         *   - (Required) Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be
+         *     - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis
+         *     - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis
+         *   - For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`
+         *
+         * **f**
+         *   - (Optional) Case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.
+         *
+         * **relativeTo**
+         *   - (Optional) The reference position (datum) from which to measure elevation. The valid values are:
+         *
+         *     - **meanSeaLevel**: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+         *     - **ellipsoid**: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+         *
+         * **token**
+         *   - (Optional) The authentication token, used to access the elevation service. Alternatively, you can supply a token in the request header with either the `Authorization` or `X-Esri-Authorization` key, using the "Bearer" scheme.
+         */
+        post: operations["ElevationAtManyPointsPost"];
+    };
+}
+export interface components {
+    schemas: {
+        /** @description A geometry point referring to a location on a map. */
+        Point: {
+            /** @description The spatial reference system the point is relative to. */
+            spatialReference: {
+                /**
+                 * @description The Well-Known ID (WKID) value of the spatial reference.
+                 * @example 4326
+                 */
+                wkid: number;
+            };
+            /**
+             * @description The X coordinate which is measured along the east/west axis.
+             * @example 86.925278
+             */
+            x: number;
+            /**
+             * @description The Y coordinate which is measured along the north/south axis.
+             * @example 27.988333
+             */
+            y: number;
+            /**
+             * @description The Z coordinate represents the vertical position of a point above or below a reference level, such as sea level (in meters, rounded to the nearest meter).
+             * @example 8744
+             */
+            z: number;
+        };
+        /** @description A structure containing human readable metadata about the specified point. */
+        ElevationInfo: {
+            /**
+             * @description The reference position (datum) from which to measure elevation.
+             * The valid values are:
+             * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.
+             *                 It takes into account the local variations in gravity and provides a consistent vertical reference.
+             * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.
+             *               It does not consider local variations in gravity and is commonly used in GPS positioning.
+             *
+             * @default meanSeaLevel
+             * @example meanSeaLevel
+             * @enum {string}
+             */
+            relativeTo: "meanSeaLevel" | "ellipsoid";
+        };
+        /** @description A structure containing a point including an elevation value (defined as Z). */
+        Elevation: {
+            /** @description The point containing the elevation. */
+            point: components["schemas"]["Point"];
+        };
+        /**
+         * @description A structure containing a collection of points which contain elevation values (defined as Z). When returned from
+         * a request to the `/elevation/at-many-points` endpoint, the order of the points will match the order of the
+         * points in the request.
+         */
+        Elevations: {
+            points: components["schemas"]["Point"][];
+        };
+        Error: {
+            /** @description Error information */
+            error: {
+                /**
+                 * @description A code identifying the type of error, either an HTTP error code, `498` (signifying invalid or expired token), or `499` (signifying missing token).
+                 * @example 400
+                 * @enum {integer}
+                 */
+                code: 400 | 401 | 403 | 404 | 413 | 415 | 498 | 499 | 500;
+                /** @description A message describing the error. */
+                message: string;
+                /** @description List of details about the error. */
+                details?: string[];
+                /**
+                 * @description URL that provides the elevation service information.
+                 * @example https://elevation-api.arcgis.com/arcgis/rest/info
+                 */
+                restInfoUrl?: string;
+            };
+        };
+        /**
+         * @description Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.
+         * @enum {string}
+         */
+        Format: "json" | "pjson";
+    };
+    responses: {
+        /** Response to a request for the elevation at a specified point. */
+        ElevationResponse: {
+            content: {
+                "application/json": {
+                    elevationInfo: components["schemas"]["ElevationInfo"];
+                    result: components["schemas"]["Elevation"];
+                };
+            };
+        };
+        /**
+         * Response to a request for the elevations at specified points. There will be one response point for each point
+         * in the request. The order of these points will match the order of the points in the request.
+         */
+        MultipleElevationsResponse: {
+            content: {
+                "application/json": {
+                    elevationInfo: components["schemas"]["ElevationInfo"];
+                    result: components["schemas"]["Elevations"];
+                };
+            };
+        };
+        /** Authentication Error. The API key or token is missing, invalid or expired. */
+        UnauthorizedErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** An error occurred on the server. */
+        ServerErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** Invalid query parameters / Incorrect portal item type. */
+        InvalidQueryErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** The supplied authentication information is valid but does not have permission to access the service. */
+        PermissionMissingErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** The requested resource cannot be accessed because of incorrect sharing permissions. */
+        ResourcePermissionErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** The request body was larger than limits defined by the service. */
+        ContentTooLargeErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** The request's message content is of a media-type that the service does not support. */
+        UnsupportedMediaTypeErrorResponse: {
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+    };
+    parameters: {
+        /** @description Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`. */
+        FormatParam: components["schemas"]["Format"];
+        /**
+         * @description The authentication token, used to access the elevation service.
+         *
+         * The `token` parameter can be either an API Key or short-lived token.
+         *
+         * Alternatively, you can supply a token in the request header with one of
+         * the following keys using the "Bearer" scheme:
+         *
+         * - `Authorization: Bearer <YOUR_TOKEN>`
+         * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`
+         *
+         * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.
+         *
+         * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/).
+         */
+        TokenParam: string;
+        /** @description The longitude of the specified point. */
+        LongitudeParam: number;
+        /** @description The latitude of the specified point. */
+        LatitudeParam: number;
+        /**
+         * @description The reference position (datum) from which to measure elevation.
+         * The valid values are:
+         * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.
+         *                 It takes into account the local variations in gravity and provides a consistent vertical reference.
+         * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.
+         *               It does not consider local variations in gravity and is commonly used in GPS positioning.
+         */
+        RelativeToParam: "meanSeaLevel" | "ellipsoid";
+    };
+}
+export interface operations {
+    /**
+     * Returns the elevation in meters at a given longitude and latitude within the WGS84 coordinate system.
+     *
+     * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+     *
+     * If the `relativeTo` query parameter is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+     *
+     * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
+     */
+    ElevationAtPointGet: {
+        parameters: {
+            query: {
+                /** The longitude of the specified point. */
+                lon: components["parameters"]["LongitudeParam"];
+                /** The latitude of the specified point. */
+                lat: components["parameters"]["LatitudeParam"];
+                /**
+                 * The reference position (datum) from which to measure elevation.
+                 * The valid values are:
+                 * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.
+                 *                 It takes into account the local variations in gravity and provides a consistent vertical reference.
+                 * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.
+                 *               It does not consider local variations in gravity and is commonly used in GPS positioning.
+                 */
+                relativeTo?: components["parameters"]["RelativeToParam"];
+                /**
+                 * The authentication token, used to access the elevation service.
+                 *
+                 * The `token` parameter can be either an API Key or short-lived token.
+                 *
+                 * Alternatively, you can supply a token in the request header with one of
+                 * the following keys using the "Bearer" scheme:
+                 *
+                 * - `Authorization: Bearer <YOUR_TOKEN>`
+                 * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`
+                 *
+                 * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.
+                 *
+                 * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/).
+                 */
+                token?: components["parameters"]["TokenParam"];
+                /** Optional, case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`. */
+                f?: components["parameters"]["FormatParam"];
+            };
+        };
+        responses: {
+            200: components["responses"]["ElevationResponse"];
+            400: components["responses"]["InvalidQueryErrorResponse"];
+            401: components["responses"]["UnauthorizedErrorResponse"];
+            403: components["responses"]["ResourcePermissionErrorResponse"];
+            "5XX": components["responses"]["ServerErrorResponse"];
+        };
+    };
+    /**
+     * Returns elevations in meters at given longitudes and latitudes within the WGS84 coordinate system.
+     *
+     * The order of the points returned by this request will be the same as the order of the points passed in the
+     * `coordinates` parameter.
+     *
+     * If the distance between the furthest West and furthest East coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.
+     *
+     * If the distance between the furthest North and furthest South coordinate exceeds 50km, the service will return a `400` HTTP response as the distance between these points is too large.
+     *
+     * If any of the points are otherwise invalid, a `400` HTTP response will be returned.
+     *
+     * By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+     *
+     * If the `relativeTo` parameter in the body is set to `ellipsoid`, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+     *
+     * Note: You cannot permanently store elevations. Please see the [Terms of use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
+     *
+     * The Post Body content type must be either:
+     * - JSON with content type of `application/json`, or
+     * - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`.
+     *
+     * The following parameters are used to fetch elevations for multiple coordinates:
+     *
+     * **coordinates**
+     *   - (Required) Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be
+     *     - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis
+     *     - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis
+     *   - For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`
+     *
+     * **f**
+     *   - (Optional) Case-sensitive parameter to specify the format in which responses are given. Can either be `json` or `pjson`.
+     *
+     * **relativeTo**
+     *   - (Optional) The reference position (datum) from which to measure elevation. The valid values are:
+     *
+     *     - **meanSeaLevel**: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
+     *     - **ellipsoid**: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
+     *
+     * **token**
+     *   - (Optional) The authentication token, used to access the elevation service. Alternatively, you can supply a token in the request header with either the `Authorization` or `X-Esri-Authorization` key, using the "Bearer" scheme.
+     */
+    ElevationAtManyPointsPost: {
+        responses: {
+            200: components["responses"]["MultipleElevationsResponse"];
+            400: components["responses"]["InvalidQueryErrorResponse"];
+            401: components["responses"]["UnauthorizedErrorResponse"];
+            403: components["responses"]["ResourcePermissionErrorResponse"];
+            413: components["responses"]["ContentTooLargeErrorResponse"];
+            415: components["responses"]["UnsupportedMediaTypeErrorResponse"];
+            "5XX": components["responses"]["ServerErrorResponse"];
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description The authentication token, used to access the elevation service.
+                     *
+                     * The `token` parameter can be either an API Key or short-lived token.
+                     *
+                     * Alternatively, you can supply a token in the request header with one of
+                     * the following keys using the "Bearer" scheme:
+                     *
+                     * - `Authorization: Bearer <YOUR_TOKEN>`
+                     * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`
+                     *
+                     * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.
+                     *
+                     * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/).
+                     *
+                     * @example My token
+                     */
+                    token?: string;
+                    /**
+                     * @description The reference position (datum) from which to measure elevation.
+                     * The valid values are:
+                     * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.
+                     *                 It takes into account the local variations in gravity and provides a consistent vertical reference.
+                     * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.
+                     *               It does not consider local variations in gravity and is commonly used in GPS positioning.
+                     *
+                     * @default meanSeaLevel
+                     * @example meanSeaLevel
+                     * @enum {string}
+                     */
+                    relativeTo?: "meanSeaLevel" | "ellipsoid";
+                    f?: components["schemas"]["Format"];
+                    /**
+                     * @description Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be
+                     *   - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis
+                     *   - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis
+                     *
+                     * For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`
+                     *
+                     * @example [
+                     *   [
+                     *     31.134167,
+                     *     29.979167
+                     *   ],
+                     *   [
+                     *     31.130833,
+                     *     29.976111
+                     *   ],
+                     *   [
+                     *     31.128333,
+                     *     29.9725
+                     *   ]
+                     * ]
+                     */
+                    coordinates: number[][];
+                };
+                "application/x-www-form-urlencoded": {
+                    /**
+                     * @description The authentication token, used to access the elevation service.
+                     *
+                     * The `token` parameter can be either an API Key or short-lived token.
+                     *
+                     * Alternatively, you can supply a token in the request header with one of
+                     * the following keys using the "Bearer" scheme:
+                     *
+                     * - `Authorization: Bearer <YOUR_TOKEN>`
+                     * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`
+                     *
+                     * The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `premium:user:elevation` privilege to use the elevation service.
+                     *
+                     * **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/).
+                     *
+                     * @example My token
+                     */
+                    token?: string;
+                    /**
+                     * @description The reference position (datum) from which to measure elevation.
+                     * The valid values are:
+                     * - meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level.
+                     *                 It takes into account the local variations in gravity and provides a consistent vertical reference.
+                     * - ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth.
+                     *               It does not consider local variations in gravity and is commonly used in GPS positioning.
+                     *
+                     * @default meanSeaLevel
+                     * @example meanSeaLevel
+                     * @enum {string}
+                     */
+                    relativeTo?: "meanSeaLevel" | "ellipsoid";
+                    f?: components["schemas"]["Format"];
+                    /**
+                     * @description Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates. The order of each pair must be
+                     *   - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis
+                     *   - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis
+                     *
+                     * For example: `[[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]`
+                     *
+                     * @example [
+                     *   [
+                     *     31.134167,
+                     *     29.979167
+                     *   ],
+                     *   [
+                     *     31.130833,
+                     *     29.976111
+                     *   ],
+                     *   [
+                     *     31.128333,
+                     *     29.9725
+                     *   ]
+                     * ]
+                     */
+                    coordinates: number[][];
+                };
+            };
+        };
+    };
+}
+export interface external {
+}

package/dist/esm/openapi-types.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};
+//# sourceMappingURL=openapi-types.js.map