import { HRN, OlpClientSettings } from "@here/olp-sdk-core"; import { ConfigApi, MetadataApi } from "@here/olp-sdk-dataservice-api"; import { CatalogRequest, CatalogVersionRequest, LayerVersionsRequest } from "@here/olp-sdk-dataservice-read"; /** * Interacts with the `DataStore` catalog. */ export declare class CatalogClient { readonly settings: OlpClientSettings; private readonly apiVersion; private readonly hrn; /** * Constructs the [[CatalogClient]] instance. * * @param catalogHrn The HERE Resource Name (HRN) of the catalog. * @param settings The [[OlpClientSettings]] instance. * @return The [[CatalogClient]] instance. */ constructor(catalogHrn: HRN, settings: OlpClientSettings); /** * Loads and caches the full catalog configuration for the requested catalog. * The catalog configuration contains descriptive and structural * information such as layer definitions and layer types. * * @summary Gets details about the requested catalog. * * @param request The [[CatalogRequest]] instance that contains the configured request parameters. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @return The catalog metadata. */ getCatalog(request: CatalogRequest, abortSignal?: AbortSignal): Promise; /** * Returns minimum version for the given catalog. If the catalog doesn't contain any versions error will be returned. * @param request Is [[CatalogVersionRequest]] instance and has ((getBillingTag)) method. * @param abortSignal A signal object that allows you to communicate with a request (such as a Fetch) * and abort it if required via an AbortController object. * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal * @returns A promise of the http response that contains the pminimum version for the given catalog. */ getEarliestVersion(request: CatalogVersionRequest, abortSignal?: AbortSignal): Promise; /** * Returns information about layer versions for the catalog version. It will return array with * all catalog layers and latest version for each layer or return error if the catalog does not * have any versions or if the version passed in the query parameter does not exist. If a layer * does not have any data for the requested version it is excluded from the response. * * @param request Is [[LayerVersionsRequest]] instance and has ((getVersion)) method. * Version - catalog version to get all related layers versions. If not defined, then the version will be the latest catalog version. * @param abortSignal A signal object that allows you to communicate with a request (such as a Fetch) * and abort it if required via an AbortController object. * @returns A promise of the http response that contains an array with all catalog layers and latest version for each layer. */ getLayerVersions(request: LayerVersionsRequest, abortSignal?: AbortSignal): Promise; /** * Gets the latest version of a catalog. * * @param request The [[CatalogVersionRequest]] instance with the `getStartVersion` method used to get * the catalog start version (exclusive). * * The default value is -1. By convention -1 * indicates the virtual initial version before the first publication that has version 0. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @returns A promise of the HTTP response that contains the payload with the latest version. */ getLatestVersion(request: CatalogVersionRequest, abortSignal?: AbortSignal): Promise; /** * Gets information about specific catalog versions. The maximum number of versions to be * returned per call is 1000 versions. If the range is bigger than 1000 versions, you get the 400 Bad Request error. * * @param request The [[CatalogVersionRequest]] instance with the `getStartVersion` and `getEndVersion` methods. * * `StartVersion` - a catalog start version (exclusive). Default is -1. By convention -1 * indicates the virtual initial version before the first publication that has version 0. * * `EndVersion` - a catalog end version (inclusive). If not defined, then the latest catalog * version is fethced and used. * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @returns A promise of the HTTP response that contains the payload with versions in the requested * range. */ getVersions(request: CatalogVersionRequest, abortSignal?: AbortSignal): Promise; /** * Fetches `baseUrl` and creates `requestBuilder` for sending requests to the API Lookup Service. * @param builderType The endpoint name that is needed to create apropriate `requestBuilder`. * @param hrn The catalog HERE Resource Name (HRN). * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request) * and, if required, abort it using the `AbortController` object. * * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * @returns `requestBuilder` */ private getRequestBuilder; }