import { IRequestOptions } from "@esri/arcgis-rest-request"; import { operations } from "./openapi-types.js"; import { IconOptions } from "./iconOptions.js"; type queryParams = Pick; type successResponse = operations["categoriesGet"]["responses"]["200"]["content"]["application/json"]; /** * The response format for {@linkcode getCategories}; */ export interface IGetCategoriesResponse extends successResponse { } /** * Options for {@linkcode getCategories}. */ export interface IGetCategoriesOptions extends Omit, queryParams { /** * Override the URL. This should be the full URL to the API endpoint you want to call. Used internally by Esri staff for testing. * @private */ endpoint?: string; icon?: IconOptions; } /** * The ArcGIS Places service has many categories (or types) of place, from * art museums to zoos. This endpoint returns all the categories including * their label and `categoryId`. The category Id can be used to search for * types of places with a `places/near-point` or `places/within-extent` * request. * * Categories also have information on their `parent`. This allows you to * search for specific categories such as "French Restaurant" - or to * look for more generic types such as "Restaurant". * * ```js * import { getCategories } from "@esri/arcgis-rest-places"; * import { ApiKeyManager } from "@esri/arcgis-rest-request"; * * const response = await getCategories({ * authentication: ApiKeyManager.fromKey("YOUR_API_KEY") * }); * * console.log(response.categories); * ``` */ export declare function getCategories(requestOptions: IGetCategoriesOptions): Promise; export {};