@linode/api-v4
Version:
JavaScript wrapper around the Linode APIv4
40 lines • 1.46 kB
TypeScript
import type { Filter, ResourcePage as Page, Params } from '../types';
import type { CreateDestinationPayload, Destination, UpdateDestinationPayload } from './types';
/**
* Returns all the information about a specified Destination.
*
* @param destinationId { number } The ID of the Destination to access.
*
*/
export declare const getDestination: (destinationId: number) => Promise<Destination>;
/**
* Returns a paginated list of Destinations.
*
*/
export declare const getDestinations: (params?: Params, filter?: Filter) => Promise<Page<Destination>>;
/**
* Adds a new Destination.
*
* @param data { object } Data for type, label, etc.
*/
export declare const createDestination: (data: CreateDestinationPayload) => Promise<Destination>;
/**
* Updates a Destination.
*
* @param destinationId { number } The ID of the Destination.
* @param data { object } Options for type, label, etc.
*/
export declare const updateDestination: (destinationId: number, data: UpdateDestinationPayload) => Promise<Destination>;
/**
* Deletes a Destination.
*
* @param destinationId { number } The ID of the Destination.
*/
export declare const deleteDestination: (destinationId: number) => Promise<{}>;
/**
* Verifies if a provided Destination is valid.
*
* @param data { object } Data for type, label, etc.
*/
export declare const verifyDestination: (data: CreateDestinationPayload) => Promise<Destination>;
//# sourceMappingURL=destinations.d.ts.map