Methods
budgetsForDeploy
- budgetsForDeploy(key: string, deployId: number): Promise<BudgetApiResponse[]>
-
Parameters
-
key: string
-
deployId: number
createUrl
- createUrl(key: string, settings: CreateUrlEndpointParameters): Promise<CreateUrlApiResponse>
-
Parameters
-
key: string
-
settings: CreateUrlEndpointParameters
deployStatus
- deployStatus(key: string, deployId: number): Promise<DeployStatusApiResponse>
-
Parameters
-
key: string
-
deployId: number
get
- get(url: URL): Promise<any>
-
Returns Promise<any>
normaliseError
- normaliseError(e: ApiError): Error
-
Returns Error
post
- post(url: URL, data?: {}): Promise<any>
-
Returns Promise<any>
prepareData
- prepareData(data: Record<string, unknown>): Record<string, string>
-
Parameters
-
data: Record<string, unknown>
Returns Record<string, string>
prepareUrl
- prepareUrl(key: string, path: string, searchParams?: {
[key: string]: string;
}): URL
-
Parameters
-
key: string
-
path: string
-
searchParams: {
[key: string]: string;
} = {}
Returns URL
put
- put(url: URL, data?: {}): Promise<any>
-
Returns Promise<any>
site
- site(key: string, siteId: number): Promise<SiteApiResponse>
-
Parameters
-
key: string
-
siteId: number
tests
- tests(key: string, urlId: number, days?: number, filters?: TestFilters): Promise<UrlApiResponse>
-
Parameters
-
key: string
-
urlId: number
-
days: number = 1
-
updateUrl
- updateUrl(key: string, urlId: number, settings: UpdateUrlEndpointParameters): Promise<UpdateUrlApiResponse>
-
Parameters
-
key: string
-
urlId: number
-
settings: UpdateUrlEndpointParameters
Transform a plain JS object into an API-compatible object