@azure-rest/maps-render 2.0.0-beta.1 → 2.0.0-beta.2

package/review/maps-render.api.md

@@ -1,564 +0,0 @@
-## API Report File for "@azure-rest/maps-render"
-
-> 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 type { LatLon } from '@azure/maps-common';
-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
-export interface CircularPath {
-    center: LatLon;
-    options?: CircularPathOptions;
-    radiusInMeters: number;
-}
-
-// @public
-export interface CircularPathOptions {
-    lineColor?: string;
-    lineOpacity?: number;
-    lineWidthInPixels?: number;
-}
-
-// @public
-export interface CopyrightCaptionOutput {
-    readonly copyrightsCaption: string;
-    readonly formatVersion?: string;
-}
-
-// @public
-export interface CopyrightOutput {
-    readonly formatVersion?: string;
-    readonly generalCopyrights?: Array<string>;
-    readonly regions?: Array<RegionCopyrightsOutput>;
-}
-
-// @public
-export function createPathQuery(paths: Array<PolygonalPath | CircularPath>): string;
-
-// @public
-export function createPinsQuery(pinSets: PinSet[]): 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 GetCopyrightCaption {
-    get(options?: RenderGetCopyrightCaptionParameters): StreamableMethod<RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetCopyrightForTile {
-    get(options: RenderGetCopyrightForTileParameters): StreamableMethod<RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetCopyrightForWorld {
-    get(options?: RenderGetCopyrightForWorldParameters): StreamableMethod<RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetCopyrightFromBoundingBox {
-    get(options: RenderGetCopyrightFromBoundingBoxParameters): StreamableMethod<RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetMapAttribution {
-    get(options: RenderGetMapAttributionParameters): StreamableMethod<RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetMapStateTile {
-    get(options: RenderGetMapStateTileParameters): StreamableMethod<RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetMapStaticImage {
-    get(options?: RenderGetMapStaticImageParameters): StreamableMethod<RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetMapTile {
-    get(options: RenderGetMapTileParameters): StreamableMethod<RenderGetMapTile200Response | RenderGetMapTileDefaultResponse>;
-}
-
-// @public (undocumented)
-export interface GetMapTileset {
-    get(options: RenderGetMapTilesetParameters): StreamableMethod<RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse>;
-}
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetMapTile200Response | RenderGetMapTileDefaultResponse): response is RenderGetMapTileDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse): response is RenderGetMapTilesetDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse): response is RenderGetMapAttributionDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse): response is RenderGetMapStateTileDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse): response is RenderGetCopyrightCaptionDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse): response is RenderGetMapStaticImageDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse): response is RenderGetCopyrightFromBoundingBoxDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse): response is RenderGetCopyrightForTileDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse): response is RenderGetCopyrightForWorldDefaultResponse;
-
-// @public
-export interface MapAttributionOutput {
-    copyrights: Array<string>;
-}
-
-// @public
-function MapsRender(credential: AzureKeyCredential, options?: ClientOptions): MapsRenderClient;
-
-// @public
-function MapsRender(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRenderClient;
-
-// @public
-function MapsRender(credential: AzureSASCredential, options?: ClientOptions): MapsRenderClient;
-export default MapsRender;
-
-// @public (undocumented)
-export type MapsRenderClient = Client & {
-    path: Routes;
-};
-
-// @public
-export interface MapsRenderClientOptions extends ClientOptions {
-    apiVersion?: string;
-}
-
-// @public
-export interface MapTilesetOutput {
-    attribution?: string;
-    bounds?: Array<number>;
-    center?: Array<number>;
-    data?: Array<string>;
-    description?: string;
-    grids?: Array<string>;
-    legend?: string;
-    maxzoom?: number;
-    minzoom?: number;
-    name?: string;
-    scheme?: string;
-    template?: string;
-    tilejson: string;
-    tiles: Array<string>;
-    version?: string;
-}
-
-// @public
-export interface Pin {
-    coordinate: LatLon;
-    label?: string;
-}
-
-// @public
-export interface PinOptions {
-    labelAnchor?: [number, number];
-    labelColor?: string;
-    labelSizeInPixels?: number;
-    opacity?: number;
-    pinAnchor?: [number, number];
-    pinColor?: string;
-    rotationInDegree?: number;
-    scale?: number;
-}
-
-// @public (undocumented)
-export interface PinSet {
-    // (undocumented)
-    options?: PinOptions;
-    // (undocumented)
-    pinImage?: "default" | "none" | string;
-    // (undocumented)
-    pins: Pin[];
-}
-
-// @public
-export interface PolygonalPath {
-    coordinates: LatLon[];
-    options?: PolygonalPathOptions;
-}
-
-// @public
-export interface PolygonalPathOptions extends CircularPathOptions {
-    fillColor?: string;
-    fillOpacity?: number;
-}
-
-// @public
-export function positionToTileXY(position: LatLon, zoom: number, tileSize: "512" | "256"): {
-    x: number;
-    y: number;
-};
-
-// @public
-export interface RegionCopyrightsCountryOutput {
-    readonly ISO3: string;
-    readonly label: string;
-}
-
-// @public (undocumented)
-export interface RegionCopyrightsOutput {
-    readonly copyrights: Array<string>;
-    readonly country: RegionCopyrightsCountryOutput;
-}
-
-// @public
-export interface RenderGetCopyrightCaption200Response extends HttpResponse {
-    // (undocumented)
-    body: CopyrightCaptionOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetCopyrightCaptionDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetCopyrightCaptionParameters = RequestParameters;
-
-// @public
-export interface RenderGetCopyrightForTile200Response extends HttpResponse {
-    // (undocumented)
-    body: CopyrightOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetCopyrightForTileDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetCopyrightForTileParameters = RenderGetCopyrightForTileQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetCopyrightForTileQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetCopyrightForTileQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetCopyrightForTileQueryParamProperties {
-    text?: "yes" | "no";
-    x: number;
-    y: number;
-    zoom: number;
-}
-
-// @public
-export interface RenderGetCopyrightForWorld200Response extends HttpResponse {
-    // (undocumented)
-    body: CopyrightOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetCopyrightForWorldDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetCopyrightForWorldParameters = RenderGetCopyrightForWorldQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetCopyrightForWorldQueryParam {
-    // (undocumented)
-    queryParameters?: RenderGetCopyrightForWorldQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetCopyrightForWorldQueryParamProperties {
-    text?: "yes" | "no";
-}
-
-// @public
-export interface RenderGetCopyrightFromBoundingBox200Response extends HttpResponse {
-    // (undocumented)
-    body: CopyrightOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetCopyrightFromBoundingBoxDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetCopyrightFromBoundingBoxParameters = RenderGetCopyrightFromBoundingBoxQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetCopyrightFromBoundingBoxQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetCopyrightFromBoundingBoxQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetCopyrightFromBoundingBoxQueryParamProperties {
-    maxcoordinates: Array<number>;
-    mincoordinates: Array<number>;
-    text?: "yes" | "no";
-}
-
-// @public
-export interface RenderGetMapAttribution200Response extends HttpResponse {
-    // (undocumented)
-    body: MapAttributionOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetMapAttributionDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetMapAttributionParameters = RenderGetMapAttributionQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetMapAttributionQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetMapAttributionQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetMapAttributionQueryParamProperties {
-    bounds: Array<number>;
-    tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
-    zoom: number;
-}
-
-// @public (undocumented)
-export interface RenderGetMapStateTile200Headers {
-    "content-type"?: string;
-}
-
-// @public
-export interface RenderGetMapStateTile200Response extends HttpResponse {
-    body: Uint8Array;
-    // (undocumented)
-    headers: RawHttpHeaders & RenderGetMapStateTile200Headers;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetMapStateTileDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetMapStateTileParameters = RenderGetMapStateTileQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetMapStateTileQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetMapStateTileQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetMapStateTileQueryParamProperties {
-    statesetId: string;
-    x: number;
-    y: number;
-    zoom: number;
-}
-
-// @public (undocumented)
-export interface RenderGetMapStaticImage200Headers {
-    "content-type"?: string;
-}
-
-// @public
-export interface RenderGetMapStaticImage200Response extends HttpResponse {
-    body: Uint8Array;
-    // (undocumented)
-    headers: RawHttpHeaders & RenderGetMapStaticImage200Headers;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetMapStaticImageDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetMapStaticImageParameters = RenderGetMapStaticImageQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetMapStaticImageQueryParam {
-    // (undocumented)
-    queryParameters?: RenderGetMapStaticImageQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetMapStaticImageQueryParamProperties {
-    bbox?: Array<number>;
-    center?: Array<number>;
-    height?: number;
-    language?: string;
-    path?: string;
-    pins?: string;
-    tilesetId?: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
-    trafficLayer?: "microsoft.traffic.relative.main" | "none";
-    view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified";
-    width?: number;
-    zoom?: number;
-}
-
-// @public (undocumented)
-export interface RenderGetMapTile200Headers {
-    "content-type"?: string;
-}
-
-// @public
-export interface RenderGetMapTile200Response extends HttpResponse {
-    body: Uint8Array;
-    // (undocumented)
-    headers: RawHttpHeaders & RenderGetMapTile200Headers;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetMapTileDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetMapTileParameters = RenderGetMapTileQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetMapTileQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetMapTileQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetMapTileQueryParamProperties {
-    language?: string;
-    tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
-    tileSize?: "256" | "512";
-    timeStamp?: Date | string;
-    view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified";
-    x: number;
-    y: number;
-    zoom: number;
-}
-
-// @public
-export interface RenderGetMapTileset200Response extends HttpResponse {
-    // (undocumented)
-    body: MapTilesetOutput;
-    // (undocumented)
-    status: "200";
-}
-
-// @public
-export interface RenderGetMapTilesetDefaultResponse extends HttpResponse {
-    // (undocumented)
-    body: ErrorResponseOutput;
-    // (undocumented)
-    status: string;
-}
-
-// @public (undocumented)
-export type RenderGetMapTilesetParameters = RenderGetMapTilesetQueryParam & RequestParameters;
-
-// @public (undocumented)
-export interface RenderGetMapTilesetQueryParam {
-    // (undocumented)
-    queryParameters: RenderGetMapTilesetQueryParamProperties;
-}
-
-// @public (undocumented)
-export interface RenderGetMapTilesetQueryParamProperties {
-    tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
-}
-
-// @public (undocumented)
-export interface Routes {
-    (path: "/map/tile"): GetMapTile;
-    (path: "/map/tileset"): GetMapTileset;
-    (path: "/map/attribution"): GetMapAttribution;
-    (path: "/map/statetile"): GetMapStateTile;
-    (path: "/map/copyright/caption/{format}", format: "json" | "xml"): GetCopyrightCaption;
-    (path: "/map/static"): GetMapStaticImage;
-    (path: "/map/copyright/bounding/{format}", format: "json" | "xml"): GetCopyrightFromBoundingBox;
-    (path: "/map/copyright/tile/{format}", format: "json" | "xml"): GetCopyrightForTile;
-    (path: "/map/copyright/world/{format}", format: "json" | "xml"): GetCopyrightForWorld;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```