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

JavaScript wrapper around the Linode APIv4

import type { PriceObject, RegionPriceObject } from './linodes/types';
export interface APIError {
    field?: string;
    reason: string;
}
export interface APIWarning {
    title: string;
    detail: string;
}
export interface ConfigOverride {
    baseURL?: string;
}
export interface ResourcePage<T> {
    data: T[];
    page: number;
    pages: number;
    results: number;
}
export type DeepPartial<T> = {
    [P in keyof T]?: DeepPartial<T[P]>;
};
export interface Params {
    page?: number;
    page_size?: number;
}
export interface RequestOptions {
    params?: Params;
    filter?: Filter;
    headers?: RequestHeaders;
}
export interface FilterConditionTypes {
    '+and'?: Filter[];
    '+or'?: Filter[] | string[];
    '+order_by'?: string;
    '+order'?: 'asc' | 'desc';
    '+eq'?: string | number;
    '+gt'?: number;
    '+gte'?: number;
    '+lt'?: number;
    '+lte'?: number;
    '+contains'?: string;
    '+neq'?: string;
}
export type Filter = LinodeFilter | LinodeFilter[];
type LinodeFilter = {
    [key in keyof FilterConditionTypes]: FilterConditionTypes[key];
} | {
    [key: string]: string | number | boolean | Filter | null | undefined;
};
type RequestHeaderValue = string | string[] | number | boolean | null;
type RequestContentType = RequestHeaderValue | 'application/json' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/html' | 'text/plain';
export interface RequestHeaders {
    [key: string]: RequestHeaderValue | undefined;
    Accept?: string;
    Authorization?: string;
    'Content-Encoding'?: string;
    'Content-Length'?: number;
    'User-Agent'?: string;
    'Content-Type'?: RequestContentType;
}
export interface PriceType {
    id: string;
    label: string;
    price: PriceObject;
    region_prices: RegionPriceObject[];
    transfer: number;
}
export {};
//# sourceMappingURL=types.d.ts.map