@linode/api-v4
Version:
JavaScript wrapper around the Linode APIv4
31 lines • 1.19 kB
TypeScript
import type { Quota, QuotaType, QuotaUsage } from './types';
import type { Filter, ResourcePage as Page, Params } from 'src/types';
/**
* getQuota
*
* Returns the details for a single quota within a particular service specified by `type`.
*
* @param type { QuotaType } retrieve a quota within this service type.
* @param id { number } the quota ID to look up.
*/
export declare const getQuota: (type: QuotaType, id: number) => Promise<Quota>;
/**
* getQuotas
*
* Returns a paginated list of quotas for a particular service specified by `type`.
*
* This request can be filtered on `quota_name`, `service_name` and `scope`.
*
* @param type { QuotaType } retrieve quotas within this service type.
*/
export declare const getQuotas: (type: QuotaType, params?: Params, filter?: Filter) => Promise<Page<Quota>>;
/**
* getQuotaUsage
*
* Returns the usage for a single quota within a particular service specified by `type`.
*
* @param type { QuotaType } retrieve a quota within this service type.
* @param id { string } the quota ID to look up.
*/
export declare const getQuotaUsage: (type: QuotaType, id: string) => Promise<QuotaUsage>;
//# sourceMappingURL=quotas.d.ts.map