@azure-rest/maps-search 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/commonjs/MapsSearch.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = MapsSearch;
+const tslib_1 = require("tslib");
+const core_auth_1 = require("@azure/core-auth");
+const maps_common_1 = require("@azure/maps-common");
+const index_js_1 = tslib_1.__importDefault(require("./generated/index.js"));
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+function MapsSearch(credential, clientIdOrOptions = {}, maybeOptions = {}) {
+    const options = typeof clientIdOrOptions === "string" ? maybeOptions : clientIdOrOptions;
+    /**
+     * maps service requires a header "ms-x-client-id", which is different from the standard Microsoft Entra ID.
+     * So we need to do our own implementation.
+     * This customized authentication is following by this guide: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/RLC-customization.md#custom-authentication
+     */
+    if ((0, core_auth_1.isTokenCredential)(credential)) {
+        const clientId = typeof clientIdOrOptions === "string" ? clientIdOrOptions : "";
+        if (!clientId) {
+            throw Error("Client id is needed for TokenCredential");
+        }
+        const client = (0, index_js_1.default)(undefined, options);
+        client.pipeline.addPolicy((0, core_rest_pipeline_1.bearerTokenAuthenticationPolicy)({
+            credential,
+            scopes: "https://atlas.microsoft.com/.default",
+        }));
+        client.pipeline.addPolicy((0, maps_common_1.createMapsClientIdPolicy)(clientId));
+        return client;
+    }
+    if ((0, core_auth_1.isSASCredential)(credential)) {
+        const client = (0, index_js_1.default)(undefined, options);
+        client.pipeline.addPolicy({
+            name: "mapsSASCredentialPolicy",
+            async sendRequest(request, next) {
+                request.headers.set("Authorization", `jwt-sas ${credential.signature}`);
+                return next(request);
+            },
+        });
+        return client;
+    }
+    return (0, index_js_1.default)(credential, options);
+}
+//# sourceMappingURL=MapsSearch.js.map

package/dist/commonjs/MapsSearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapsSearch.js","sourceRoot":"","sources":["../../src/MapsSearch.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAqElC,6BAyCC;;AA1GD,gDAAsE;AACtE,oDAA8D;AAE9D,4EAAgD;AAChD,kEAA4E;AA6D5E,SAAwB,UAAU,CAChC,UAAqE,EACrE,oBAA4C,EAAE,EAC9C,eAA8B,EAAE;IAEhC,MAAM,OAAO,GAAG,OAAO,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC;IAEzF;;;;OAIG;IACH,IAAI,IAAA,6BAAiB,EAAC,UAAU,CAAC,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,OAAO,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;QAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,MAAM,GAAG,IAAA,kBAAY,EAAC,SAAgB,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,QAAQ,CAAC,SAAS,CACvB,IAAA,oDAA+B,EAAC;YAC9B,UAAU;YACV,MAAM,EAAE,sCAAsC;SAC/C,CAAC,CACH,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAA,sCAAwB,EAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,IAAA,2BAAe,EAAC,UAAU,CAAC,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,IAAA,kBAAY,EAAC,SAAgB,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxB,IAAI,EAAE,yBAAyB;YAC/B,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI;gBAC7B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,WAAW,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;gBACxE,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,IAAA,kBAAY,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport type { AzureKeyCredential, AzureSASCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isSASCredential, isTokenCredential } from \"@azure/core-auth\";\nimport { createMapsClientIdPolicy } from \"@azure/maps-common\";\nimport type { MapsSearchClient } from \"./generated/index.js\";\nimport createClient from \"./generated/index.js\";\nimport { bearerTokenAuthenticationPolicy } from \"@azure/core-rest-pipeline\";\n\n/**\n * Creates an instance of MapsSearchClient from a subscription key.\n *\n * @example\n * ```ts snippet:ReadmeSampleCreateClient_SubscriptionKey\n * import { AzureKeyCredential } from \"@azure/core-auth\";\n * import MapsSearch from \"@azure-rest/maps-search\";\n *\n * const credential = new AzureKeyCredential(\"<subscription-key>\");\n * const client = MapsSearch(credential);\n *```\n *\n * @param credential - An AzureKeyCredential instance used to authenticate requests to the service\n * @param options - Options used to configure the Search Client\n */\nexport default function MapsSearch(\n  credential: AzureKeyCredential,\n  options?: ClientOptions,\n): MapsSearchClient;\n/**\n * Creates an instance of MapsSearch from an Azure Identity `TokenCredential`.\n *\n * @example\n * ```ts snippet:ReadmeSampleCreateClient_TokenCredential\n * import { DefaultAzureCredential } from \"@azure/identity\";\n * import MapsSearch from \"@azure-rest/maps-search\";\n *\n * const credential = new DefaultAzureCredential();\n * const client = MapsSearch(credential, \"<maps-account-client-id>\");\n *```\n *\n * @param credential - An TokenCredential instance used to authenticate requests to the service\n * @param mapsAccountClientId - The Azure Maps client id of a specific map resource\n * @param options - Options used to configure the Search Client\n */\nexport default function MapsSearch(\n  credential: TokenCredential,\n  mapsAccountClientId: string,\n  options?: ClientOptions,\n): MapsSearchClient;\n/**\n * Creates an instance of MapsSearch from an Azure Identity `AzureSASCredential`.\n *\n * @example\n * ```ts snippet:ReadmeSampleCreateClient_SASToken\n * import { AzureSASCredential } from \"@azure/core-auth\";\n * import MapsSearch from \"@azure-rest/maps-search\";\n *\n * const credential = new AzureSASCredential(\"<SAS Token>\");\n * const client = MapsSearch(credential);\n * ```\n *\n * @param credential - An AzureSASCredential instance used to authenticate requests to the service\n * @param options - Options used to configure the Search Client\n */\nexport default function MapsSearch(\n  credential: AzureSASCredential,\n  options?: ClientOptions,\n): MapsSearchClient;\nexport default function MapsSearch(\n  credential: TokenCredential | AzureKeyCredential | AzureSASCredential,\n  clientIdOrOptions: string | ClientOptions = {},\n  maybeOptions: ClientOptions = {},\n): MapsSearchClient {\n  const options = typeof clientIdOrOptions === \"string\" ? maybeOptions : clientIdOrOptions;\n\n  /**\n   * maps service requires a header \"ms-x-client-id\", which is different from the standard Microsoft Entra ID.\n   * So we need to do our own implementation.\n   * This customized authentication is following by this guide: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/RLC-customization.md#custom-authentication\n   */\n  if (isTokenCredential(credential)) {\n    const clientId = typeof clientIdOrOptions === \"string\" ? clientIdOrOptions : \"\";\n    if (!clientId) {\n      throw Error(\"Client id is needed for TokenCredential\");\n    }\n    const client = createClient(undefined as any, options);\n    client.pipeline.addPolicy(\n      bearerTokenAuthenticationPolicy({\n        credential,\n        scopes: \"https://atlas.microsoft.com/.default\",\n      }),\n    );\n    client.pipeline.addPolicy(createMapsClientIdPolicy(clientId));\n    return client;\n  }\n\n  if (isSASCredential(credential)) {\n    const client = createClient(undefined as any, options);\n    client.pipeline.addPolicy({\n      name: \"mapsSASCredentialPolicy\",\n      async sendRequest(request, next) {\n        request.headers.set(\"Authorization\", `jwt-sas ${credential.signature}`);\n        return next(request);\n      },\n    });\n    return client;\n  }\n\n  return createClient(credential, options);\n}\n"]}

package/dist/commonjs/generated/clientDefinitions.d.ts

@@ -0,0 +1,137 @@
+import { SearchGetGeocodingParameters, SearchGetGeocodingBatchParameters, SearchGetPolygonParameters, SearchGetReverseGeocodingParameters, SearchGetReverseGeocodingBatchParameters } from "./parameters.js";
+import { SearchGetGeocoding200Response, SearchGetGeocodingDefaultResponse, SearchGetGeocodingBatch200Response, SearchGetGeocodingBatchDefaultResponse, SearchGetPolygon200Response, SearchGetPolygonDefaultResponse, SearchGetReverseGeocoding200Response, SearchGetReverseGeocodingDefaultResponse, SearchGetReverseGeocodingBatch200Response, SearchGetReverseGeocodingBatchDefaultResponse } from "./responses.js";
+import { Client, StreamableMethod } from "@azure-rest/core-client";
+export interface GetGeocoding {
+    /**
+     *
+     * The `Get Geocoding` API is an HTTP `GET` request that returns the longitude and latitude coordinates of the location being searched.
+     *
+     * In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties and states. The response also returns detailed address properties such as street, postal code, municipality, and country/region information.
+     */
+    get(options?: SearchGetGeocodingParameters): StreamableMethod<SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse>;
+}
+export interface GetGeocodingBatch {
+    /**
+     *
+     * The `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.
+     *
+     * ### Submit Synchronous Batch Request
+     * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
+     * ```
+     * POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01
+     * ```
+     * ### POST Body for Batch Request
+     * To send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:
+     *
+     *
+     * ```
+     * {
+     *   "batchItems": [
+     *     {
+     *       "addressLine": "One, Microsoft Way, Redmond, WA 98052",
+     *       "top": 2
+     *     },
+     *     {
+     *       "addressLine": "Pike Pl",
+     *       "adminDistrict": "WA",
+     *       "locality": "Seattle",
+     *       "top": 3
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * A _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).
+     *
+     *
+     * The batch should contain at least **1** query.
+     *
+     *
+     * ### Batch Response Model
+     * The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:
+     *
+     *   - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.
+     *
+     *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+     *
+     *
+     *
+     */
+    post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>;
+}
+export interface GetPolygon {
+    /**
+     *
+     * The `Get Polygon` API is an HTTP `GET` request that supplies polygon data of a geographical area outline such as a city or a country region.
+     */
+    get(options: SearchGetPolygonParameters): StreamableMethod<SearchGetPolygon200Response | SearchGetPolygonDefaultResponse>;
+}
+export interface GetReverseGeocoding {
+    /**
+     *
+     * The `Get Reverse Geocoding` API is an HTTP `GET` request used to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Useful in tracking applications where you receive a GPS feed from the device or asset and wish to know the address associated with the coordinates. This endpoint will return address information for a given coordinate.
+     */
+    get(options: SearchGetReverseGeocodingParameters): StreamableMethod<SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse>;
+}
+export interface GetReverseGeocodingBatch {
+    /**
+     *
+     * The `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.
+     *
+     * ### Submit Synchronous Batch Request
+     * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
+     * ```
+     * POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01
+     * ```
+     * ### POST Body for Batch Request
+     * To send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:
+     *
+     *
+     * ```
+     * {
+     *   "batchItems": [
+     *     {
+     *       "coordinates": [-122.128275, 47.639429],
+     *       "resultTypes": ["Address", "PopulatedPlace"]
+     *     },
+     *     {
+     *       "coordinates": [-122.341979399674, 47.6095253501216]
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * A _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).
+     *
+     *
+     * The batch should contain at least **1** query.
+     *
+     *
+     * ### Batch Response Model
+     * The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:
+     *
+     *   - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.
+     *
+     *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+     *
+     *
+     *
+     */
+    post(options: SearchGetReverseGeocodingBatchParameters): StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>;
+}
+export interface Routes {
+    /** Resource for '/geocode' has methods for the following verbs: get */
+    (path: "/geocode"): GetGeocoding;
+    /** Resource for '/geocode:batch' has methods for the following verbs: post */
+    (path: "/geocode:batch"): GetGeocodingBatch;
+    /** Resource for '/search/polygon' has methods for the following verbs: get */
+    (path: "/search/polygon"): GetPolygon;
+    /** Resource for '/reverseGeocode' has methods for the following verbs: get */
+    (path: "/reverseGeocode"): GetReverseGeocoding;
+    /** Resource for '/reverseGeocode:batch' has methods for the following verbs: post */
+    (path: "/reverseGeocode:batch"): GetReverseGeocodingBatch;
+}
+export type MapsSearchClient = Client & {
+    path: Routes;
+};
+//# sourceMappingURL=clientDefinitions.d.ts.map

package/dist/commonjs/generated/clientDefinitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../../src/generated/clientDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,4BAA4B,EAC5B,iCAAiC,EACjC,0BAA0B,EAC1B,mCAAmC,EACnC,wCAAwC,EACzC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,6BAA6B,EAC7B,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,EACtC,2BAA2B,EAC3B,+BAA+B,EAC/B,oCAAoC,EACpC,wCAAwC,EACxC,yCAAyC,EACzC,6CAA6C,EAC9C,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CACjB,6BAA6B,GAAG,iCAAiC,CAClE,CAAC;CACH;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,CACF,OAAO,EAAE,iCAAiC,GACzC,gBAAgB,CACjB,kCAAkC,GAAG,sCAAsC,CAC5E,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,0BAA0B,GAClC,gBAAgB,CACjB,2BAA2B,GAAG,+BAA+B,CAC9D,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,GAAG,CACD,OAAO,EAAE,mCAAmC,GAC3C,gBAAgB,CACf,oCAAoC,GACpC,wCAAwC,CAC3C,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,OAAO,EAAE,wCAAwC,GAChD,gBAAgB,CACf,yCAAyC,GACzC,6CAA6C,CAChD,CAAC;CACH;AAED,MAAM,WAAW,MAAM;IACrB,uEAAuE;IACvE,CAAC,IAAI,EAAE,UAAU,GAAG,YAAY,CAAC;IACjC,8EAA8E;IAC9E,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAC5C,8EAA8E;IAC9E,CAAC,IAAI,EAAE,iBAAiB,GAAG,UAAU,CAAC;IACtC,8EAA8E;IAC9E,CAAC,IAAI,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;IAC/C,qFAAqF;IACrF,CAAC,IAAI,EAAE,uBAAuB,GAAG,wBAAwB,CAAC;CAC3D;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/commonjs/generated/clientDefinitions.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clientDefinitions.js.map

package/dist/commonjs/generated/clientDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.js","sourceRoot":"","sources":["../../../src/generated/clientDefinitions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  SearchGetGeocodingParameters,\n  SearchGetGeocodingBatchParameters,\n  SearchGetPolygonParameters,\n  SearchGetReverseGeocodingParameters,\n  SearchGetReverseGeocodingBatchParameters,\n} from \"./parameters.js\";\nimport {\n  SearchGetGeocoding200Response,\n  SearchGetGeocodingDefaultResponse,\n  SearchGetGeocodingBatch200Response,\n  SearchGetGeocodingBatchDefaultResponse,\n  SearchGetPolygon200Response,\n  SearchGetPolygonDefaultResponse,\n  SearchGetReverseGeocoding200Response,\n  SearchGetReverseGeocodingDefaultResponse,\n  SearchGetReverseGeocodingBatch200Response,\n  SearchGetReverseGeocodingBatchDefaultResponse,\n} from \"./responses.js\";\nimport { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface GetGeocoding {\n  /**\n   *\n   * The `Get Geocoding` API is an HTTP `GET` request that returns the longitude and latitude coordinates of the location being searched.\n   *\n   * In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties and states. The response also returns detailed address properties such as street, postal code, municipality, and country/region information.\n   */\n  get(\n    options?: SearchGetGeocodingParameters,\n  ): StreamableMethod<\n    SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse\n  >;\n}\n\nexport interface GetGeocodingBatch {\n  /**\n   *\n   * The `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.\n   *\n   * ### Submit Synchronous Batch Request\n   * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n   * ```\n   * POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n   * ```\n   * ### POST Body for Batch Request\n   * To send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n   *\n   *\n   * ```\n   * {\n   *   \"batchItems\": [\n   *     {\n   *       \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n   *       \"top\": 2\n   *     },\n   *     {\n   *       \"addressLine\": \"Pike Pl\",\n   *       \"adminDistrict\": \"WA\",\n   *       \"locality\": \"Seattle\",\n   *       \"top\": 3\n   *     }\n   *   ]\n   * }\n   * ```\n   *\n   * A _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n   *\n   *\n   * The batch should contain at least **1** query.\n   *\n   *\n   * ### Batch Response Model\n   * The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n   *\n   *   - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n   *\n   *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n   *\n   *\n   *\n   */\n  post(\n    options: SearchGetGeocodingBatchParameters,\n  ): StreamableMethod<\n    SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse\n  >;\n}\n\nexport interface GetPolygon {\n  /**\n   *\n   * The `Get Polygon` API is an HTTP `GET` request that supplies polygon data of a geographical area outline such as a city or a country region.\n   */\n  get(\n    options: SearchGetPolygonParameters,\n  ): StreamableMethod<\n    SearchGetPolygon200Response | SearchGetPolygonDefaultResponse\n  >;\n}\n\nexport interface GetReverseGeocoding {\n  /**\n   *\n   * The `Get Reverse Geocoding` API is an HTTP `GET` request used to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Useful in tracking applications where you receive a GPS feed from the device or asset and wish to know the address associated with the coordinates. This endpoint will return address information for a given coordinate.\n   */\n  get(\n    options: SearchGetReverseGeocodingParameters,\n  ): StreamableMethod<\n    | SearchGetReverseGeocoding200Response\n    | SearchGetReverseGeocodingDefaultResponse\n  >;\n}\n\nexport interface GetReverseGeocodingBatch {\n  /**\n   *\n   * The `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.\n   *\n   * ### Submit Synchronous Batch Request\n   * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n   * ```\n   * POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n   * ```\n   * ### POST Body for Batch Request\n   * To send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n   *\n   *\n   * ```\n   * {\n   *   \"batchItems\": [\n   *     {\n   *       \"coordinates\": [-122.128275, 47.639429],\n   *       \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n   *     },\n   *     {\n   *       \"coordinates\": [-122.341979399674, 47.6095253501216]\n   *     }\n   *   ]\n   * }\n   * ```\n   *\n   * A _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n   *\n   *\n   * The batch should contain at least **1** query.\n   *\n   *\n   * ### Batch Response Model\n   * The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n   *\n   *   - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n   *\n   *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n   *\n   *\n   *\n   */\n  post(\n    options: SearchGetReverseGeocodingBatchParameters,\n  ): StreamableMethod<\n    | SearchGetReverseGeocodingBatch200Response\n    | SearchGetReverseGeocodingBatchDefaultResponse\n  >;\n}\n\nexport interface Routes {\n  /** Resource for '/geocode' has methods for the following verbs: get */\n  (path: \"/geocode\"): GetGeocoding;\n  /** Resource for '/geocode:batch' has methods for the following verbs: post */\n  (path: \"/geocode:batch\"): GetGeocodingBatch;\n  /** Resource for '/search/polygon' has methods for the following verbs: get */\n  (path: \"/search/polygon\"): GetPolygon;\n  /** Resource for '/reverseGeocode' has methods for the following verbs: get */\n  (path: \"/reverseGeocode\"): GetReverseGeocoding;\n  /** Resource for '/reverseGeocode:batch' has methods for the following verbs: post */\n  (path: \"/reverseGeocode:batch\"): GetReverseGeocodingBatch;\n}\n\nexport type MapsSearchClient = Client & {\n  path: Routes;\n};\n"]}

package/dist/commonjs/generated/index.d.ts

@@ -0,0 +1,10 @@
+import MapsSearchClient from "./mapsSearchClient.js";
+export * from "./mapsSearchClient.js";
+export * from "./parameters.js";
+export * from "./responses.js";
+export * from "./clientDefinitions.js";
+export * from "./isUnexpected.js";
+export * from "./models.js";
+export * from "./outputModels.js";
+export default MapsSearchClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/generated/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/index.ts"],"names":[],"mappings":"AAGA,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AAErD,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAElC,eAAe,gBAAgB,CAAC"}

package/dist/commonjs/generated/index.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const mapsSearchClient_js_1 = tslib_1.__importDefault(require("./mapsSearchClient.js"));
+tslib_1.__exportStar(require("./mapsSearchClient.js"), exports);
+tslib_1.__exportStar(require("./parameters.js"), exports);
+tslib_1.__exportStar(require("./responses.js"), exports);
+tslib_1.__exportStar(require("./clientDefinitions.js"), exports);
+tslib_1.__exportStar(require("./isUnexpected.js"), exports);
+tslib_1.__exportStar(require("./models.js"), exports);
+tslib_1.__exportStar(require("./outputModels.js"), exports);
+exports.default = mapsSearchClient_js_1.default;
+//# sourceMappingURL=index.js.map

package/dist/commonjs/generated/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,wFAAqD;AAErD,gEAAsC;AACtC,0DAAgC;AAChC,yDAA+B;AAC/B,iEAAuC;AACvC,4DAAkC;AAClC,sDAA4B;AAC5B,4DAAkC;AAElC,kBAAe,6BAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport MapsSearchClient from \"./mapsSearchClient.js\";\n\nexport * from \"./mapsSearchClient.js\";\nexport * from \"./parameters.js\";\nexport * from \"./responses.js\";\nexport * from \"./clientDefinitions.js\";\nexport * from \"./isUnexpected.js\";\nexport * from \"./models.js\";\nexport * from \"./outputModels.js\";\n\nexport default MapsSearchClient;\n"]}

package/dist/commonjs/generated/isUnexpected.d.ts

@@ -0,0 +1,7 @@
+import { SearchGetGeocoding200Response, SearchGetGeocodingDefaultResponse, SearchGetGeocodingBatch200Response, SearchGetGeocodingBatchDefaultResponse, SearchGetPolygon200Response, SearchGetPolygonDefaultResponse, SearchGetReverseGeocoding200Response, SearchGetReverseGeocodingDefaultResponse, SearchGetReverseGeocodingBatch200Response, SearchGetReverseGeocodingBatchDefaultResponse } from "./responses.js";
+export declare function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response is SearchGetGeocodingDefaultResponse;
+export declare function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response is SearchGetGeocodingBatchDefaultResponse;
+export declare function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response is SearchGetPolygonDefaultResponse;
+export declare function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response is SearchGetReverseGeocodingDefaultResponse;
+export declare function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response is SearchGetReverseGeocodingBatchDefaultResponse;
+//# sourceMappingURL=isUnexpected.d.ts.map

package/dist/commonjs/generated/isUnexpected.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUnexpected.d.ts","sourceRoot":"","sources":["../../../src/generated/isUnexpected.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,6BAA6B,EAC7B,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,EACtC,2BAA2B,EAC3B,+BAA+B,EAC/B,oCAAoC,EACpC,wCAAwC,EACxC,yCAAyC,EACzC,6CAA6C,EAC9C,MAAM,gBAAgB,CAAC;AAUxB,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,6BAA6B,GAAG,iCAAiC,GAC1E,QAAQ,IAAI,iCAAiC,CAAC;AACjD,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,kCAAkC,GAClC,sCAAsC,GACzC,QAAQ,IAAI,sCAAsC,CAAC;AACtD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,2BAA2B,GAAG,+BAA+B,GACtE,QAAQ,IAAI,+BAA+B,CAAC;AAC/C,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,oCAAoC,GACpC,wCAAwC,GAC3C,QAAQ,IAAI,wCAAwC,CAAC;AACxD,wBAAgB,YAAY,CAC1B,QAAQ,EACJ,yCAAyC,GACzC,6CAA6C,GAChD,QAAQ,IAAI,6CAA6C,CAAC"}

package/dist/commonjs/generated/isUnexpected.js

@@ -0,0 +1,78 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUnexpected = isUnexpected;
+const responseMap = {
+    "GET /geocode": ["200"],
+    "POST /geocode:batch": ["200"],
+    "GET /search/polygon": ["200"],
+    "GET /reverseGeocode": ["200"],
+    "POST /reverseGeocode:batch": ["200"],
+};
+function isUnexpected(response) {
+    const lroOriginal = response.headers["x-ms-original-url"];
+    const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
+    const method = response.request.method;
+    let pathDetails = responseMap[`${method} ${url.pathname}`];
+    if (!pathDetails) {
+        pathDetails = getParametrizedPathSuccess(method, url.pathname);
+    }
+    return !pathDetails.includes(response.status);
+}
+function getParametrizedPathSuccess(method, path) {
+    var _a, _b, _c, _d;
+    const pathParts = path.split("/");
+    // Traverse list to match the longest candidate
+    // matchedLen: the length of candidate path
+    // matchedValue: the matched status code array
+    let matchedLen = -1, matchedValue = [];
+    // Iterate the responseMap to find a match
+    for (const [key, value] of Object.entries(responseMap)) {
+        // Extracting the path from the map key which is in format
+        // GET /path/foo
+        if (!key.startsWith(method)) {
+            continue;
+        }
+        const candidatePath = getPathFromMapKey(key);
+        // Get each part of the url path
+        const candidateParts = candidatePath.split("/");
+        // track if we have found a match to return the values found.
+        let found = true;
+        for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
+            if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) &&
+                ((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.indexOf("}")) !== -1) {
+                const start = candidateParts[i].indexOf("}") + 1, end = (_c = candidateParts[i]) === null || _c === void 0 ? void 0 : _c.length;
+                // If the current part of the candidate is a "template" part
+                // Try to use the suffix of pattern to match the path
+                // {guid} ==> $
+                // {guid}:export ==> :export$
+                const isMatched = new RegExp(`${(_d = candidateParts[i]) === null || _d === void 0 ? void 0 : _d.slice(start, end)}`).test(pathParts[j] || "");
+                if (!isMatched) {
+                    found = false;
+                    break;
+                }
+                continue;
+            }
+            // If the candidate part is not a template and
+            // the parts don't match mark the candidate as not found
+            // to move on with the next candidate path.
+            if (candidateParts[i] !== pathParts[j]) {
+                found = false;
+                break;
+            }
+        }
+        // We finished evaluating the current candidate parts
+        // Update the matched value if and only if we found the longer pattern
+        if (found && candidatePath.length > matchedLen) {
+            matchedLen = candidatePath.length;
+            matchedValue = value;
+        }
+    }
+    return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+    const pathStart = mapKey.indexOf("/");
+    return mapKey.slice(pathStart);
+}
+//# sourceMappingURL=isUnexpected.js.map

package/dist/commonjs/generated/isUnexpected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../../src/generated/isUnexpected.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AA4ClC,oCA0BC;AAvDD,MAAM,WAAW,GAA6B;IAC5C,cAAc,EAAE,CAAC,KAAK,CAAC;IACvB,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,4BAA4B,EAAE,CAAC,KAAK,CAAC;CACtC,CAAC;AAuBF,SAAgB,YAAY,CAC1B,QAUiD;IAOjD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY;;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;IAE9B,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KACE,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAC3D,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAChB,CAAC,EAAE,EAAE,CAAC,EAAE,EACR,CAAC;YACD,IACE,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,UAAU,CAAC,GAAG,CAAC;gBAClC,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EACtC,CAAC;gBACD,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAC1B,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAC1C,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE3B,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  SearchGetGeocoding200Response,\n  SearchGetGeocodingDefaultResponse,\n  SearchGetGeocodingBatch200Response,\n  SearchGetGeocodingBatchDefaultResponse,\n  SearchGetPolygon200Response,\n  SearchGetPolygonDefaultResponse,\n  SearchGetReverseGeocoding200Response,\n  SearchGetReverseGeocodingDefaultResponse,\n  SearchGetReverseGeocodingBatch200Response,\n  SearchGetReverseGeocodingBatchDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /geocode\": [\"200\"],\n  \"POST /geocode:batch\": [\"200\"],\n  \"GET /search/polygon\": [\"200\"],\n  \"GET /reverseGeocode\": [\"200\"],\n  \"POST /reverseGeocode:batch\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse,\n): response is SearchGetGeocodingDefaultResponse;\nexport function isUnexpected(\n  response:\n    | SearchGetGeocodingBatch200Response\n    | SearchGetGeocodingBatchDefaultResponse,\n): response is SearchGetGeocodingBatchDefaultResponse;\nexport function isUnexpected(\n  response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse,\n): response is SearchGetPolygonDefaultResponse;\nexport function isUnexpected(\n  response:\n    | SearchGetReverseGeocoding200Response\n    | SearchGetReverseGeocodingDefaultResponse,\n): response is SearchGetReverseGeocodingDefaultResponse;\nexport function isUnexpected(\n  response:\n    | SearchGetReverseGeocodingBatch200Response\n    | SearchGetReverseGeocodingBatchDefaultResponse,\n): response is SearchGetReverseGeocodingBatchDefaultResponse;\nexport function isUnexpected(\n  response:\n    | SearchGetGeocoding200Response\n    | SearchGetGeocodingDefaultResponse\n    | SearchGetGeocodingBatch200Response\n    | SearchGetGeocodingBatchDefaultResponse\n    | SearchGetPolygon200Response\n    | SearchGetPolygonDefaultResponse\n    | SearchGetReverseGeocoding200Response\n    | SearchGetReverseGeocodingDefaultResponse\n    | SearchGetReverseGeocodingBatch200Response\n    | SearchGetReverseGeocodingBatchDefaultResponse,\n): response is\n  | SearchGetGeocodingDefaultResponse\n  | SearchGetGeocodingBatchDefaultResponse\n  | SearchGetPolygonDefaultResponse\n  | SearchGetReverseGeocodingDefaultResponse\n  | SearchGetReverseGeocodingBatchDefaultResponse {\n  const lroOriginal = response.headers[\"x-ms-original-url\"];\n  const url = new URL(lroOriginal ?? response.request.url);\n  const method = response.request.method;\n  let pathDetails = responseMap[`${method} ${url.pathname}`];\n  if (!pathDetails) {\n    pathDetails = getParametrizedPathSuccess(method, url.pathname);\n  }\n  return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: string[] = [];\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(responseMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (\n      let i = candidateParts.length - 1, j = pathParts.length - 1;\n      i >= 1 && j >= 1;\n      i--, j--\n    ) {\n      if (\n        candidateParts[i]?.startsWith(\"{\") &&\n        candidateParts[i]?.indexOf(\"}\") !== -1\n      ) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(\n          `${candidateParts[i]?.slice(start, end)}`,\n        ).test(pathParts[j] || \"\");\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n"]}

package/dist/commonjs/generated/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const logger: import("@azure/logger").AzureLogger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/commonjs/generated/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/generated/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,qCAAoC,CAAC"}

package/dist/commonjs/generated/logger.js

@@ -0,0 +1,8 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger_1 = require("@azure/logger");
+exports.logger = (0, logger_1.createClientLogger)("maps-search");
+//# sourceMappingURL=logger.js.map

package/dist/commonjs/generated/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/generated/logger.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,0CAAmD;AACtC,QAAA,MAAM,GAAG,IAAA,2BAAkB,EAAC,aAAa,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createClientLogger } from \"@azure/logger\";\nexport const logger = createClientLogger(\"maps-search\");\n"]}

package/dist/commonjs/generated/mapsSearchClient.d.ts

@@ -0,0 +1,15 @@
+import { ClientOptions } from "@azure-rest/core-client";
+import { KeyCredential } from "@azure/core-auth";
+import { MapsSearchClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface MapsSearchClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `MapsSearchClient`
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(credentials: KeyCredential, { apiVersion, ...options }?: MapsSearchClientOptions): MapsSearchClient;
+//# sourceMappingURL=mapsSearchClient.d.ts.map

package/dist/commonjs/generated/mapsSearchClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapsSearchClient.d.ts","sourceRoot":"","sources":["../../../src/generated/mapsSearchClient.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,6CAA6C;AAC7C,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,WAAW,EAAE,aAAa,EAC1B,EAAE,UAAyB,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACtE,gBAAgB,CA6ClB"}

package/dist/commonjs/generated/mapsSearchClient.js

@@ -0,0 +1,45 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createClient;
+const tslib_1 = require("tslib");
+const core_client_1 = require("@azure-rest/core-client");
+const logger_js_1 = require("./logger.js");
+/**
+ * Initialize a new instance of `MapsSearchClient`
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+function createClient(credentials, _a = {}) {
+    var _b, _c, _d, _e, _f, _g;
+    var { apiVersion = "2023-06-01" } = _a, options = tslib_1.__rest(_a, ["apiVersion"]);
+    const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `https://atlas.microsoft.com`;
+    const userAgentInfo = `azsdk-js-maps-search-rest/2.0.0-beta.2`;
+    const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+        : `${userAgentInfo}`;
+    options = Object.assign(Object.assign({}, options), { userAgentOptions: {
+            userAgentPrefix,
+        }, loggingOptions: {
+            logger: (_e = (_d = options.loggingOptions) === null || _d === void 0 ? void 0 : _d.logger) !== null && _e !== void 0 ? _e : logger_js_1.logger.info,
+        }, credentials: {
+            apiKeyHeaderName: (_g = (_f = options.credentials) === null || _f === void 0 ? void 0 : _f.apiKeyHeaderName) !== null && _g !== void 0 ? _g : "subscription-key",
+        } });
+    const client = (0, core_client_1.getClient)(endpointUrl, credentials, options);
+    client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
+    client.pipeline.addPolicy({
+        name: "ClientApiVersionPolicy",
+        sendRequest: (req, next) => {
+            // Use the apiVersion defined in request url directly
+            // Append one if there is no apiVersion and we have one at client options
+            const url = new URL(req.url);
+            if (!url.searchParams.get("api-version") && apiVersion) {
+                req.url = `${req.url}${Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
+            }
+            return next(req);
+        },
+    });
+    return client;
+}
+//# sourceMappingURL=mapsSearchClient.js.map

package/dist/commonjs/generated/mapsSearchClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapsSearchClient.js","sourceRoot":"","sources":["../../../src/generated/mapsSearchClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAkBlC,+BAgDC;;AAhED,yDAAmE;AACnE,2CAAqC;AAUrC;;;;GAIG;AACH,SAAwB,YAAY,CAClC,WAA0B,EAC1B,KAAqE,EAAE;;QAAvE,EAAE,UAAU,GAAG,YAAY,OAA4C,EAAvC,OAAO,sBAAvC,cAAyC,CAAF;IAEvC,MAAM,WAAW,GACf,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,6BAA6B,CAAC;IACvE,MAAM,aAAa,GAAG,wCAAwC,CAAC;IAC/D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,kBAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,gBAAgB,EACd,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,gBAAgB,mCAAI,kBAAkB;SAC9D,GACF,CAAC;IACF,MAAM,MAAM,GAAG,IAAA,uBAAS,EACtB,WAAW,EACX,WAAW,EACX,OAAO,CACY,CAAC;IAEtB,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { getClient, ClientOptions } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport { KeyCredential } from \"@azure/core-auth\";\nimport { MapsSearchClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface MapsSearchClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `MapsSearchClient`\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  credentials: KeyCredential,\n  { apiVersion = \"2023-06-01\", ...options }: MapsSearchClientOptions = {},\n): MapsSearchClient {\n  const endpointUrl =\n    options.endpoint ?? options.baseUrl ?? `https://atlas.microsoft.com`;\n  const userAgentInfo = `azsdk-js-maps-search-rest/2.0.0-beta.2`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      apiKeyHeaderName:\n        options.credentials?.apiKeyHeaderName ?? \"subscription-key\",\n    },\n  };\n  const client = getClient(\n    endpointUrl,\n    credentials,\n    options,\n  ) as MapsSearchClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}

package/dist/commonjs/generated/models.d.ts

@@ -0,0 +1,97 @@
+/** The list of address geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query. */
+export interface GeocodingBatchRequestBody {
+    /** The list of queries to process. */
+    batchItems?: Array<GeocodingBatchRequestItem>;
+}
+/** Batch Query object */
+export interface GeocodingBatchRequestItem {
+    /** id of the request which would show in corresponding batchItem */
+    optionalId?: string;
+    /** Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20. */
+    top?: number;
+    /** A string that contains information about a location, such as an address or landmark name. */
+    query?: string;
+    /**
+     * The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    addressLine?: string;
+    /**
+     * Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    countryRegion?: string;
+    /**
+     * A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. For more information, see Location and Area Types. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.
+     *
+     * Example: [lon1, lat1, lon2, lat2]
+     */
+    bbox?: Array<number>;
+    /** A string that specifies an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. */
+    view?: string;
+    /** A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: [lon, lat] */
+    coordinates?: Array<number>;
+    /**
+     * The country subdivision portion of an address, such as WA.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    adminDistrict?: string;
+    /**
+     * The county for the structured address, such as King.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    adminDistrict2?: string;
+    /**
+     * The named area for the structured address.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    adminDistrict3?: string;
+    /**
+     * The locality portion of an address, such as Seattle.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    locality?: string;
+    /**
+     * The postal code portion of an address.
+     *
+     * **If query is given, should not use this parameter.**
+     */
+    postalCode?: string;
+}
+/** The list of reverse geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query. */
+export interface ReverseGeocodingBatchRequestBody {
+    /** The list of queries to process. */
+    batchItems?: Array<ReverseGeocodingBatchRequestItem>;
+}
+/** Batch Query object */
+export interface ReverseGeocodingBatchRequestItem {
+    /** id of the request which would show in corresponding batchItem */
+    optionalId?: string;
+    /** The coordinates of the location that you want to reverse geocode. Example: [lon,lat] */
+    coordinates?: Array<number>;
+    /**
+     * Specify entity types that you want in the response. Only the types you specify will be returned. If the point cannot be mapped to the entity types you specify, no location information is returned in the response.
+     * Default value is all possible entities.
+     * A comma separated list of entity types selected from the following options.
+     *
+     * - Address
+     * - Neighborhood
+     * - PopulatedPlace
+     * - Postcode1
+     * - AdminDivision1
+     * - AdminDivision2
+     * - CountryRegion
+     *
+     * These entity types are ordered from the most specific entity to the least specific entity. When entities of more than one entity type are found, only the most specific entity is returned. For example, if you specify Address and AdminDistrict1 as entity types and entities were found for both types, only the Address entity information is returned in the response.
+     */
+    resultTypes?: Array<"Address" | "Neighborhood" | "PopulatedPlace" | "Postcode1" | "AdminDivision1" | "AdminDivision2" | "CountryRegion">;
+    /** A string that specifies an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. */
+    view?: string;
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/commonjs/generated/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/generated/models.ts"],"names":[],"mappings":"AAGA,8IAA8I;AAC9I,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,UAAU,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CAC/C;AAED,yBAAyB;AACzB,MAAM,WAAW,yBAAyB;IACxC,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iGAAiG;IACjG,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,+NAA+N;IAC/N,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4NAA4N;IAC5N,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,8IAA8I;AAC9I,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC;IACtC,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;CACtD;AAED,yBAAyB;AACzB,MAAM,WAAW,gCAAgC;IAC/C,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,CAClB,CAAC;IACF,+NAA+N;IAC/N,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}

package/dist/commonjs/generated/models.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=models.js.map

package/dist/commonjs/generated/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/generated/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** The list of address geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query. */\nexport interface GeocodingBatchRequestBody {\n  /** The list of queries to process. */\n  batchItems?: Array<GeocodingBatchRequestItem>;\n}\n\n/** Batch Query object */\nexport interface GeocodingBatchRequestItem {\n  /** id of the request which would show in corresponding batchItem */\n  optionalId?: string;\n  /** Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20. */\n  top?: number;\n  /** A string that contains information about a location, such as an address or landmark name. */\n  query?: string;\n  /**\n   * The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  addressLine?: string;\n  /**\n   * Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  countryRegion?: string;\n  /**\n   * A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. For more information, see Location and Area Types. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.\n   *\n   * Example: [lon1, lat1, lon2, lat2]\n   */\n  bbox?: Array<number>;\n  /** A string that specifies an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. */\n  view?: string;\n  /** A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: [lon, lat] */\n  coordinates?: Array<number>;\n  /**\n   * The country subdivision portion of an address, such as WA.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  adminDistrict?: string;\n  /**\n   * The county for the structured address, such as King.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  adminDistrict2?: string;\n  /**\n   * The named area for the structured address.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  adminDistrict3?: string;\n  /**\n   * The locality portion of an address, such as Seattle.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  locality?: string;\n  /**\n   * The postal code portion of an address.\n   *\n   * **If query is given, should not use this parameter.**\n   */\n  postalCode?: string;\n}\n\n/** The list of reverse geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query. */\nexport interface ReverseGeocodingBatchRequestBody {\n  /** The list of queries to process. */\n  batchItems?: Array<ReverseGeocodingBatchRequestItem>;\n}\n\n/** Batch Query object */\nexport interface ReverseGeocodingBatchRequestItem {\n  /** id of the request which would show in corresponding batchItem */\n  optionalId?: string;\n  /** The coordinates of the location that you want to reverse geocode. Example: [lon,lat] */\n  coordinates?: Array<number>;\n  /**\n   * Specify entity types that you want in the response. Only the types you specify will be returned. If the point cannot be mapped to the entity types you specify, no location information is returned in the response.\n   * Default value is all possible entities.\n   * A comma separated list of entity types selected from the following options.\n   *\n   * - Address\n   * - Neighborhood\n   * - PopulatedPlace\n   * - Postcode1\n   * - AdminDivision1\n   * - AdminDivision2\n   * - CountryRegion\n   *\n   * These entity types are ordered from the most specific entity to the least specific entity. When entities of more than one entity type are found, only the most specific entity is returned. For example, if you specify Address and AdminDistrict1 as entity types and entities were found for both types, only the Address entity information is returned in the response.\n   */\n  resultTypes?: Array<\n    | \"Address\"\n    | \"Neighborhood\"\n    | \"PopulatedPlace\"\n    | \"Postcode1\"\n    | \"AdminDivision1\"\n    | \"AdminDivision2\"\n    | \"CountryRegion\"\n  >;\n  /** A string that specifies an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. */\n  view?: string;\n}\n"]}