cloudflare
Version:
The official TypeScript library for the Cloudflare API
474 lines (406 loc) • 9.09 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import * as Core from "../../core";
import { APIResource } from "../../resource";
import * as TestsAPI from "./tests";
export class Tests extends APIResource {
/**
* Starts a test for a specific webpage, in a specific region.
*/
create(
url: string,
params: TestCreateParams,
options?: Core.RequestOptions,
): Core.APIPromise<ObservatoryPageTest> {
const { zone_id, ...body } = params;
return (
this._client.post(`/zones/${zone_id}/speed_api/pages/${url}/tests`, {
body,
...options,
}) as Core.APIPromise<{ result: ObservatoryPageTest }>
)._thenUnwrap((obj) => obj.result);
}
/**
* Test history (list of tests) for a specific webpage.
*/
list(
url: string,
params: TestListParams,
options?: Core.RequestOptions,
): Core.APIPromise<TestListResponse> {
const { zone_id, ...query } = params;
return this._client.get(`/zones/${zone_id}/speed_api/pages/${url}/tests`, { query, ...options });
}
/**
* Deletes all tests for a specific webpage from a specific region. Deleted tests
* are still counted as part of the quota.
*/
delete(
url: string,
params: TestDeleteParams,
options?: Core.RequestOptions,
): Core.APIPromise<TestDeleteResponse> {
const { zone_id, region } = params;
return (
this._client.delete(`/zones/${zone_id}/speed_api/pages/${url}/tests`, {
query: { region },
...options,
}) as Core.APIPromise<{ result: TestDeleteResponse }>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the result of a specific test.
*/
get(
url: string,
testId: string,
params: TestGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<ObservatoryPageTest> {
const { zone_id } = params;
return (
this._client.get(
`/zones/${zone_id}/speed_api/pages/${url}/tests/${testId}`,
options,
) as Core.APIPromise<{ result: ObservatoryPageTest }>
)._thenUnwrap((obj) => obj.result);
}
}
export interface ObservatoryPageTest {
/**
* UUID
*/
id?: string;
date?: string;
/**
* The Lighthouse report.
*/
desktopReport?: ObservatoryPageTest.DesktopReport;
/**
* The Lighthouse report.
*/
mobileReport?: ObservatoryPageTest.MobileReport;
/**
* A test region with a label.
*/
region?: ObservatoryPageTest.Region;
/**
* The frequency of the test.
*/
scheduleFrequency?: 'DAILY' | 'WEEKLY';
/**
* A URL.
*/
url?: string;
}
export namespace ObservatoryPageTest {
/**
* The Lighthouse report.
*/
export interface DesktopReport {
/**
* Cumulative Layout Shift.
*/
cls?: number;
/**
* The type of device.
*/
deviceType?: 'DESKTOP' | 'MOBILE';
error?: DesktopReport.Error;
/**
* First Contentful Paint.
*/
fcp?: number;
/**
* The URL to the full Lighthouse JSON report.
*/
jsonReportUrl?: string;
/**
* Largest Contentful Paint.
*/
lcp?: number;
/**
* The Lighthouse performance score.
*/
performanceScore?: number;
/**
* Speed Index.
*/
si?: number;
/**
* The state of the Lighthouse report.
*/
state?: 'RUNNING' | 'COMPLETE' | 'FAILED';
/**
* Total Blocking Time.
*/
tbt?: number;
/**
* Time To First Byte.
*/
ttfb?: number;
/**
* Time To Interactive.
*/
tti?: number;
}
export namespace DesktopReport {
export interface Error {
/**
* The error code of the Lighthouse result.
*/
code?: 'NOT_REACHABLE' | 'DNS_FAILURE' | 'NOT_HTML' | 'LIGHTHOUSE_TIMEOUT' | 'UNKNOWN';
/**
* Detailed error message.
*/
detail?: string;
/**
* The final URL displayed to the user.
*/
finalDisplayedUrl?: string;
}
}
/**
* The Lighthouse report.
*/
export interface MobileReport {
/**
* Cumulative Layout Shift.
*/
cls?: number;
/**
* The type of device.
*/
deviceType?: 'DESKTOP' | 'MOBILE';
error?: MobileReport.Error;
/**
* First Contentful Paint.
*/
fcp?: number;
/**
* The URL to the full Lighthouse JSON report.
*/
jsonReportUrl?: string;
/**
* Largest Contentful Paint.
*/
lcp?: number;
/**
* The Lighthouse performance score.
*/
performanceScore?: number;
/**
* Speed Index.
*/
si?: number;
/**
* The state of the Lighthouse report.
*/
state?: 'RUNNING' | 'COMPLETE' | 'FAILED';
/**
* Total Blocking Time.
*/
tbt?: number;
/**
* Time To First Byte.
*/
ttfb?: number;
/**
* Time To Interactive.
*/
tti?: number;
}
export namespace MobileReport {
export interface Error {
/**
* The error code of the Lighthouse result.
*/
code?: 'NOT_REACHABLE' | 'DNS_FAILURE' | 'NOT_HTML' | 'LIGHTHOUSE_TIMEOUT' | 'UNKNOWN';
/**
* Detailed error message.
*/
detail?: string;
/**
* The final URL displayed to the user.
*/
finalDisplayedUrl?: string;
}
}
/**
* A test region with a label.
*/
export interface Region {
label?: string;
/**
* A test region.
*/
value?:
| 'asia-east1'
| 'asia-northeast1'
| 'asia-northeast2'
| 'asia-south1'
| 'asia-southeast1'
| 'australia-southeast1'
| 'europe-north1'
| 'europe-southwest1'
| 'europe-west1'
| 'europe-west2'
| 'europe-west3'
| 'europe-west4'
| 'europe-west8'
| 'europe-west9'
| 'me-west1'
| 'southamerica-east1'
| 'us-central1'
| 'us-east1'
| 'us-east4'
| 'us-south1'
| 'us-west1';
}
}
export interface TestListResponse {
errors: Array<TestListResponse.Error>;
messages: Array<TestListResponse.Message>;
/**
* Whether the API call was successful.
*/
success: boolean;
result_info?: TestListResponse.ResultInfo;
}
export namespace TestListResponse {
export interface Error {
code: number;
message: string;
}
export interface Message {
code: number;
message: string;
}
export interface ResultInfo {
count?: number;
page?: number;
per_page?: number;
total_count?: number;
}
}
export interface TestDeleteResponse {
/**
* Number of items affected.
*/
count?: number;
}
export interface TestCreateParams {
/**
* Path param: Identifier
*/
zone_id: string;
/**
* Body param: A test region.
*/
region?:
| 'asia-east1'
| 'asia-northeast1'
| 'asia-northeast2'
| 'asia-south1'
| 'asia-southeast1'
| 'australia-southeast1'
| 'europe-north1'
| 'europe-southwest1'
| 'europe-west1'
| 'europe-west2'
| 'europe-west3'
| 'europe-west4'
| 'europe-west8'
| 'europe-west9'
| 'me-west1'
| 'southamerica-east1'
| 'us-central1'
| 'us-east1'
| 'us-east4'
| 'us-south1'
| 'us-west1';
}
export interface TestListParams {
/**
* Path param: Identifier
*/
zone_id: string;
/**
* Query param:
*/
page?: number;
/**
* Query param:
*/
per_page?: number;
/**
* Query param: A test region.
*/
region?:
| 'asia-east1'
| 'asia-northeast1'
| 'asia-northeast2'
| 'asia-south1'
| 'asia-southeast1'
| 'australia-southeast1'
| 'europe-north1'
| 'europe-southwest1'
| 'europe-west1'
| 'europe-west2'
| 'europe-west3'
| 'europe-west4'
| 'europe-west8'
| 'europe-west9'
| 'me-west1'
| 'southamerica-east1'
| 'us-central1'
| 'us-east1'
| 'us-east4'
| 'us-south1'
| 'us-west1';
}
export interface TestDeleteParams {
/**
* Path param: Identifier
*/
zone_id: string;
/**
* Query param: A test region.
*/
region?:
| 'asia-east1'
| 'asia-northeast1'
| 'asia-northeast2'
| 'asia-south1'
| 'asia-southeast1'
| 'australia-southeast1'
| 'europe-north1'
| 'europe-southwest1'
| 'europe-west1'
| 'europe-west2'
| 'europe-west3'
| 'europe-west4'
| 'europe-west8'
| 'europe-west9'
| 'me-west1'
| 'southamerica-east1'
| 'us-central1'
| 'us-east1'
| 'us-east4'
| 'us-south1'
| 'us-west1';
}
export interface TestGetParams {
/**
* Identifier
*/
zone_id: string;
}
export namespace Tests {
export import ObservatoryPageTest = TestsAPI.ObservatoryPageTest;
export import TestListResponse = TestsAPI.TestListResponse;
export import TestDeleteResponse = TestsAPI.TestDeleteResponse;
export import TestCreateParams = TestsAPI.TestCreateParams;
export import TestListParams = TestsAPI.TestListParams;
export import TestDeleteParams = TestsAPI.TestDeleteParams;
export import TestGetParams = TestsAPI.TestGetParams;
}