@azure-rest/maps-geolocation 1.0.0-beta.4 → 1.0.0-beta.5

package/types/maps-geolocation-rest.d.ts

@@ -1,159 +0,0 @@
-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 { RequestParameters } from '@azure-rest/core-client';
-import { StreamableMethod } from '@azure-rest/core-client';
-import type { TokenCredential } from '@azure/core-auth';
-
-/** The object containing the country/region information. */
-export declare interface CountryRegionOutput {
-    /** The IP Address's 2-character code [(ISO 3166-1)](https://www.iso.org/iso-3166-country-codes.html) of the country or region. Please note, IP address in ranges reserved for special purpose will return Null for country/region. */
-    readonly isoCode?: string;
-}
-
-/** The resource management error additional info. */
-export declare interface ErrorAdditionalInfoOutput {
-    /** The additional info type. */
-    readonly type?: string;
-    /** The additional info. */
-    readonly info?: Record<string, unknown>;
-}
-
-/** The error detail. */
-export declare interface ErrorDetailOutput {
-    /** The error code. */
-    readonly code?: string;
-    /** The error message. */
-    readonly message?: string;
-    /** The error target. */
-    readonly target?: string;
-    /** The error details. */
-    readonly details?: Array<ErrorDetailOutput>;
-    /** The error additional info. */
-    readonly additionalInfo?: Array<ErrorAdditionalInfoOutput>;
-}
-
-/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
-export declare interface ErrorResponseOutput {
-    /** The error object. */
-    error?: ErrorDetailOutput;
-}
-
-/**
- *
- * The `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.
- */
-export declare interface GeolocationGetLocation200Response extends HttpResponse {
-    status: "200";
-    body: IpAddressToLocationResultOutput;
-}
-
-/**
- *
- * The `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.
- */
-export declare interface GeolocationGetLocationDefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorResponseOutput;
-}
-
-export declare type GeolocationGetLocationParameters = GeolocationGetLocationQueryParam & RequestParameters;
-
-export declare interface GeolocationGetLocationQueryParam {
-    queryParameters: GeolocationGetLocationQueryParamProperties;
-}
-
-export declare interface GeolocationGetLocationQueryParamProperties {
-    /** The IP address. Both IPv4 and IPv6 are allowed. */
-    ip: string;
-}
-
-export declare interface GetLocation {
-    /**
-     *
-     * The `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.
-     */
-    get(options: GeolocationGetLocationParameters): StreamableMethod<GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse>;
-}
-
-/** This object is returned from a successful call to IP Address to country/region API */
-export declare interface IpAddressToLocationResultOutput {
-    /** The object containing the country/region information. */
-    readonly countryRegion?: CountryRegionOutput;
-    /** The IP Address of the request. */
-    readonly ipAddress?: string;
-}
-
-export declare function isUnexpected(response: GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse): response is GeolocationGetLocationDefaultResponse;
-
-/**
- * Creates an instance of MapsGeolocationClient from a subscription key.
- *
- * @example
- * ```ts
- * import MapsGeolocation from "@azure-rest/maps-geolocation";
- * import { AzureKeyCredential } from "@azure/core-auth";
- *
- * const credential = new AzureKeyCredential("<subscription-key>");
- * const client = MapsGeolocation(credential);
- *```
- *
- * @param credential - An AzureKeyCredential instance used to authenticate requests to the service
- * @param options - Options used to configure the Geolocation Client
- */
-declare function MapsGeolocation(credential: AzureKeyCredential, options?: ClientOptions): MapsGeolocationClient;
-
-/**
- * Creates an instance of MapsGeolocation from an Azure Identity `TokenCredential`.
- *
- * @example
- * ```ts
- * import MapsGeolocation from "@azure-rest/maps-geo-location";
- * import { DefaultAzureCredential } from "@azure/identity";
- *
- * const credential = new DefaultAzureCredential();
- * const client = MapsGeolocation(credential, "<maps-account-client-id>");
- *```
- *
- * @param credential - An TokenCredential instance used to authenticate requests to the service
- * @param mapsAccountClientId - The Azure Maps client id of a specific map resource
- * @param options - Options used to configure the Route Client
- */
-declare function MapsGeolocation(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsGeolocationClient;
-
-/**
- * Creates an instance of MapsGeolocation from an Azure Identity `AzureSASCredential`.
- *
- * @example
- * ```ts
- * import MapsGeolocation from "@azure-rest/maps-geo-location";
- * import { AzureSASCredential } from "@azure/core-auth";
- *
- * const credential = new AzureSASCredential("<SAS Token>");
- * const client = MapsGeolocation(credential);
- * ```
- *
- * @param credential - An AzureSASCredential instance used to authenticate requests to the service
- * @param options - Options used to configure the Geolocation Client
- */
-declare function MapsGeolocation(credential: AzureSASCredential, options?: ClientOptions): MapsGeolocationClient;
-export default MapsGeolocation;
-
-export declare type MapsGeolocationClient = Client & {
-    path: Routes;
-};
-
-/** The optional parameters for the client */
-export declare interface MapsGeolocationClientOptions extends ClientOptions {
-    /** The api version option of the client */
-    apiVersion?: string;
-}
-
-export declare interface Routes {
-    /** Resource for '/geolocation/ip/\{format\}' has methods for the following verbs: get */
-    (path: "/geolocation/ip/{format}", format: "json"): GetLocation;
-}
-
-export { }