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

package/review/maps-search-node.api.md

@@ -0,0 +1,549 @@
+## API Report File for "@azure-rest/maps-search"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { AzureKeyCredential } from '@azure/core-auth';
+import type { AzureSASCredential } from '@azure/core-auth';
+import { Client } from '@azure-rest/core-client';
+import { ClientOptions } from '@azure-rest/core-client';
+import { HttpResponse } from '@azure-rest/core-client';
+import { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import { RequestParameters } from '@azure-rest/core-client';
+import { StreamableMethod } from '@azure-rest/core-client';
+import type { TokenCredential } from '@azure/core-auth';
+
+// @public (undocumented)
+export interface AddressAdminDistrictsItemOutput {
+    name?: string;
+    shortName?: string;
+}
+
+// @public (undocumented)
+export interface AddressCountryRegionOutput {
+    ISO?: string;
+    name?: string;
+}
+
+// @public
+export interface AddressOutput {
+    addressLine?: string;
+    adminDistricts?: Array<AddressAdminDistrictsItemOutput>;
+    // (undocumented)
+    countryRegion?: AddressCountryRegionOutput;
+    formattedAddress?: string;
+    intersection?: IntersectionOutput;
+    locality?: string;
+    neighborhood?: string;
+    postalCode?: string;
+}
+
+// @public
+export interface BoundaryOutput extends GeoJsonFeatureOutputParent, BoundaryPropertiesOutput {
+    // (undocumented)
+    type: "Boundary";
+}
+
+// @public
+export interface BoundaryPropertiesOutput {
+    copyright?: string;
+    copyrightURL?: string;
+    geometriesCopyright?: Array<GeometryCopyrightOutput>;
+    name?: string;
+}
+
+// @public
+export interface ErrorAdditionalInfoOutput {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetailOutput {
+    readonly additionalInfo?: Array<ErrorAdditionalInfoOutput>;
+    readonly code?: string;
+    readonly details?: Array<ErrorDetailOutput>;
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponseOutput {
+    error?: ErrorDetailOutput;
+}
+
+// @public (undocumented)
+export interface FeaturesItemOutput {
+    bbox?: Array<number>;
+    geometry: GeoJsonPointOutput;
+    id?: string;
+    // (undocumented)
+    properties?: FeaturesItemPropertiesOutput;
+    type?: "Feature";
+}
+
+// @public (undocumented)
+export interface FeaturesItemPropertiesOutput {
+    address?: AddressOutput;
+    confidence?: "High" | "Medium" | "Low";
+    geocodePoints?: Array<GeocodePointsItemOutput>;
+    matchCodes?: Array<"Good" | "Ambiguous" | "UpHierarchy">;
+    type?: string;
+}
+
+// @public (undocumented)
+export interface GeocodePointsItemOutput {
+    calculationMethod?: "Interpolation" | "InterpolationOffset" | "Parcel" | "Rooftop";
+    geometry?: GeoJsonPointOutput;
+    usageTypes?: Array<"Display" | "Route">;
+}
+
+// @public
+export interface GeocodingBatchRequestBody {
+    batchItems?: Array<GeocodingBatchRequestItem>;
+}
+
+// @public
+export interface GeocodingBatchRequestItem {
+    addressLine?: string;
+    adminDistrict?: string;
+    adminDistrict2?: string;
+    adminDistrict3?: string;
+    bbox?: Array<number>;
+    coordinates?: Array<number>;
+    countryRegion?: string;
+    locality?: string;
+    optionalId?: string;
+    postalCode?: string;
+    query?: string;
+    top?: number;
+    view?: string;
+}
+
+// @public (undocumented)
+export interface GeocodingBatchResponseItemOutput {
+    error?: ErrorDetailOutput;
+    // (undocumented)
+    features?: Array<FeaturesItemOutput>;
+    nextLink?: string;
+    optionalId?: string;
+    type?: "FeatureCollection";
+}
+
+// @public
+export interface GeocodingBatchResponseOutput {
+    batchItems?: Array<GeocodingBatchResponseItemOutput>;
+    nextLink?: string;
+    summary?: GeocodingBatchResponseSummaryOutput;
+}
+
+// @public
+export interface GeocodingBatchResponseSummaryOutput {
+    successfulRequests?: number;
+    totalRequests?: number;
+}
+
+// @public
+export interface GeocodingResponseOutput {
+    // (undocumented)
+    features?: Array<FeaturesItemOutput>;
+    nextLink?: string;
+    type?: "FeatureCollection";
+}
+
+// @public (undocumented)
+export interface GeoJsonFeatureCollectionDataOutput {
+    features: Array<GeoJsonFeatureOutput>;
+}
+
+// @public
+export interface GeoJsonFeatureCollectionOutput extends GeoJsonObjectOutputParent, GeoJsonFeatureCollectionDataOutput {
+    // (undocumented)
+    type: "FeatureCollection";
+}
+
+// @public (undocumented)
+export interface GeoJsonFeatureDataOutput {
+    featureType?: string;
+    geometry: GeoJsonGeometryOutput;
+    id?: string;
+    properties?: Record<string, unknown>;
+}
+
+// @public
+export type GeoJsonFeatureOutput = GeoJsonFeatureOutputParent | BoundaryOutput;
+
+// @public
+export interface GeoJsonFeatureOutputParent extends GeoJsonObjectOutputParent, GeoJsonFeatureDataOutput {
+    // (undocumented)
+    type: "Feature" | "Boundary";
+}
+
+// @public (undocumented)
+export interface GeoJsonGeometryCollectionDataOutput {
+    geometries: Array<GeoJsonGeometryOutput>;
+}
+
+// @public
+export interface GeoJsonGeometryCollectionOutput extends GeoJsonGeometryOutputParent, GeoJsonGeometryCollectionDataOutput {
+    // (undocumented)
+    type: "GeometryCollection";
+}
+
+// @public
+export type GeoJsonGeometryOutput = GeoJsonGeometryOutputParent | GeoJsonPointOutput | GeoJsonMultiPointOutput | GeoJsonLineStringOutput | GeoJsonMultiLineStringOutput | GeoJsonPolygonOutput | GeoJsonMultiPolygonOutput | GeoJsonGeometryCollectionOutput;
+
+// @public
+export interface GeoJsonGeometryOutputParent extends GeoJsonObjectOutputParent {
+    // (undocumented)
+    type: "GeoJsonGeometry" | "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection";
+}
+
+// @public (undocumented)
+export interface GeoJsonLineStringDataOutput {
+    coordinates: Array<Array<number>>;
+}
+
+// @public
+export interface GeoJsonLineStringOutput extends GeoJsonGeometryOutputParent, GeoJsonLineStringDataOutput {
+    // (undocumented)
+    type: "LineString";
+}
+
+// @public (undocumented)
+export interface GeoJsonMultiLineStringDataOutput {
+    coordinates: Array<Array<Array<number>>>;
+}
+
+// @public
+export interface GeoJsonMultiLineStringOutput extends GeoJsonGeometryOutputParent, GeoJsonMultiLineStringDataOutput {
+    // (undocumented)
+    type: "MultiLineString";
+}
+
+// @public
+export interface GeoJsonMultiPointDataOutput {
+    coordinates: Array<Array<number>>;
+}
+
+// @public
+export interface GeoJsonMultiPointOutput extends GeoJsonGeometryOutputParent, GeoJsonMultiPointDataOutput {
+    // (undocumented)
+    type: "MultiPoint";
+}
+
+// @public (undocumented)
+export interface GeoJsonMultiPolygonDataOutput {
+    coordinates: Array<Array<Array<Array<number>>>>;
+}
+
+// @public
+export interface GeoJsonMultiPolygonOutput extends GeoJsonGeometryOutputParent, GeoJsonMultiPolygonDataOutput {
+    // (undocumented)
+    type: "MultiPolygon";
+}
+
+// @public
+export type GeoJsonObjectOutput = GeoJsonGeometryOutput | GeoJsonPointOutput | GeoJsonFeatureOutput | BoundaryOutput | GeoJsonMultiPointOutput | GeoJsonLineStringOutput | GeoJsonMultiLineStringOutput | GeoJsonPolygonOutput | GeoJsonMultiPolygonOutput | GeoJsonGeometryCollectionOutput | GeoJsonFeatureCollectionOutput;
+
+// @public
+export interface GeoJsonObjectOutputParent {
+    bbox?: Array<number>;
+    // (undocumented)
+    type: "GeoJsonObject" | "GeoJsonGeometry" | "Point" | "Feature" | "Boundary" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection" | "FeatureCollection";
+}
+
+// @public
+export interface GeoJsonPointDataOutput {
+    coordinates: Array<number>;
+}
+
+// @public
+export interface GeoJsonPointOutput extends GeoJsonGeometryOutputParent, GeoJsonPointDataOutput {
+    // (undocumented)
+    type: "Point";
+}
+
+// @public (undocumented)
+export interface GeoJsonPolygonDataOutput {
+    coordinates: Array<Array<Array<number>>>;
+}
+
+// @public
+export interface GeoJsonPolygonOutput extends GeoJsonGeometryOutputParent, GeoJsonPolygonDataOutput {
+    // (undocumented)
+    type: "Polygon";
+}
+
+// @public
+export interface GeometryCopyrightOutput {
+    copyright?: string;
+    sourceName?: string;
+}
+
+// @public (undocumented)
+export interface GetGeocoding {
+    get(options?: SearchGetGeocodingParameters): StreamableMethod<SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetGeocodingBatch {
+    post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetPolygon {
+    get(options: SearchGetPolygonParameters): StreamableMethod<SearchGetPolygon200Response | SearchGetPolygonDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetReverseGeocoding {
+    get(options: SearchGetReverseGeocodingParameters): StreamableMethod<SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetReverseGeocodingBatch {
+    post(options: SearchGetReverseGeocodingBatchParameters): StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>;
+}
+
+// @public
+export interface IntersectionOutput {
+    baseStreet?: string;
+    displayName?: string;
+    intersectionType?: string;
+    secondaryStreet1?: string;
+    secondaryStreet2?: string;
+}
+
+// @public (undocumented)
+export function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response is SearchGetGeocodingDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response is SearchGetGeocodingBatchDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response is SearchGetPolygonDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response is SearchGetReverseGeocodingDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response is SearchGetReverseGeocodingBatchDefaultResponse;
+
+// @public
+function MapsSearch(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient;
+
+// @public
+function MapsSearch(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient;
+
+// @public
+function MapsSearch(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient;
+export default MapsSearch;
+
+// @public (undocumented)
+export type MapsSearchClient = Client & {
+    path: Routes;
+};
+
+// @public
+export interface MapsSearchClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface ReverseGeocodingBatchRequestBody {
+    batchItems?: Array<ReverseGeocodingBatchRequestItem>;
+}
+
+// @public
+export interface ReverseGeocodingBatchRequestItem {
+    coordinates?: Array<number>;
+    optionalId?: string;
+    resultTypes?: Array<"Address" | "Neighborhood" | "PopulatedPlace" | "Postcode1" | "AdminDivision1" | "AdminDivision2" | "CountryRegion">;
+    view?: string;
+}
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/geocode"): GetGeocoding;
+    (path: "/geocode:batch"): GetGeocodingBatch;
+    (path: "/search/polygon"): GetPolygon;
+    (path: "/reverseGeocode"): GetReverseGeocoding;
+    (path: "/reverseGeocode:batch"): GetReverseGeocodingBatch;
+}
+
+// @public (undocumented)
+export interface SearchGetGeocoding200Headers {
+    "x-ms-request-id"?: string;
+}
+
+// @public
+export interface SearchGetGeocoding200Response extends HttpResponse {
+    // (undocumented)
+    body: GeocodingResponseOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & SearchGetGeocoding200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface SearchGetGeocodingBatch200Response extends HttpResponse {
+    // (undocumented)
+    body: GeocodingBatchResponseOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface SearchGetGeocodingBatchBodyParam {
+    body: GeocodingBatchRequestBody;
+}
+
+// @public
+export interface SearchGetGeocodingBatchDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface SearchGetGeocodingBatchMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type SearchGetGeocodingBatchParameters = SearchGetGeocodingBatchMediaTypesParam & SearchGetGeocodingBatchBodyParam & RequestParameters;
+
+// @public
+export interface SearchGetGeocodingDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type SearchGetGeocodingParameters = SearchGetGeocodingQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface SearchGetGeocodingQueryParam {
+    // (undocumented)
+    queryParameters?: SearchGetGeocodingQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface SearchGetGeocodingQueryParamProperties {
+    addressLine?: string;
+    adminDistrict?: string;
+    adminDistrict2?: string;
+    adminDistrict3?: string;
+    bbox?: Array<number>;
+    coordinates?: Array<number>;
+    countryRegion?: string;
+    locality?: string;
+    postalCode?: string;
+    query?: string;
+    top?: number;
+    view?: string;
+}
+
+// @public
+export interface SearchGetPolygon200Response extends HttpResponse {
+    // (undocumented)
+    body: BoundaryOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface SearchGetPolygonDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type SearchGetPolygonParameters = SearchGetPolygonQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface SearchGetPolygonQueryParam {
+    // (undocumented)
+    queryParameters: SearchGetPolygonQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface SearchGetPolygonQueryParamProperties {
+    coordinates: Array<number>;
+    resolution?: "small" | "medium" | "large" | "huge";
+    resultType?: "countryRegion" | "adminDistrict" | "adminDistrict2" | "postalCode" | "postalCode2" | "postalCode3" | "postalCode4" | "neighborhood" | "locality";
+    view?: string;
+}
+
+// @public
+export interface SearchGetReverseGeocoding200Response extends HttpResponse {
+    // (undocumented)
+    body: GeocodingResponseOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface SearchGetReverseGeocodingBatch200Response extends HttpResponse {
+    // (undocumented)
+    body: GeocodingBatchResponseOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface SearchGetReverseGeocodingBatchBodyParam {
+    body: ReverseGeocodingBatchRequestBody;
+}
+
+// @public
+export interface SearchGetReverseGeocodingBatchDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface SearchGetReverseGeocodingBatchMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type SearchGetReverseGeocodingBatchParameters = SearchGetReverseGeocodingBatchMediaTypesParam & SearchGetReverseGeocodingBatchBodyParam & RequestParameters;
+
+// @public
+export interface SearchGetReverseGeocodingDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type SearchGetReverseGeocodingParameters = SearchGetReverseGeocodingQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface SearchGetReverseGeocodingQueryParam {
+    // (undocumented)
+    queryParameters: SearchGetReverseGeocodingQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface SearchGetReverseGeocodingQueryParamProperties {
+    coordinates: Array<number>;
+    resultTypes?: Array<"Address" | "Neighborhood" | "PopulatedPlace" | "Postcode1" | "AdminDivision1" | "AdminDivision2" | "CountryRegion">;
+    view?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```