@linode/api-v4/lib/regions/regions.d.ts

JavaScript wrapper around the Linode APIv4

import { Filter, Params, ResourcePage as Page } from '../types';
import { Region, RegionAvailability } from './types';
/**
 * getRegions
 *
 * Return a list of available Regions (datacenters).
 * The response will be paginated, but the number of
 * available regions is small enough that multiple
 * pages are unlikely to be necessary.
 *
 * Filters are not included, as none of the fields
 * in a Region response object are filterable.
 *
 */
export declare const getRegions: (params?: Params) => Promise<Page<Region>>;
/**
 * getRegion
 *
 * Return detailed information about a particular region.
 *
 * @param regionId { string } The region to be retrieved.
 *
 */
export declare const getRegion: (regionId: string) => Promise<Region>;
export { Region };
/**
 * getRegionAvailabilities
 *
 * Returns the availability status for all Linode plans for all regions.
 */
export declare const getRegionAvailabilities: (params?: Params, filter?: Filter) => Promise<Page<RegionAvailability>>;
/**
 * getRegionAvailability
 *
 * Return the availability status of Linode plans for the given region.
 *
 * @param regionId { string } The region to get the availabilities for
 */
export declare const getRegionAvailability: (regionId: string) => Promise<RegionAvailability[]>;
//# sourceMappingURL=regions.d.ts.map