105 lines
4.1 KiB
TypeScript
105 lines
4.1 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
import * as TestsAPI from "./pages/tests.js";
|
|
export declare class ScheduleResource extends APIResource {
|
|
/**
|
|
* Creates a scheduled test for a page.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const schedule = await client.speed.schedule.create(
|
|
* 'example.com',
|
|
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
create(url: string, params: ScheduleCreateParams, options?: Core.RequestOptions): Core.APIPromise<ScheduleCreateResponse>;
|
|
/**
|
|
* Deletes a scheduled test for a page.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const schedule = await client.speed.schedule.delete(
|
|
* 'example.com',
|
|
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
delete(url: string, params: ScheduleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<ScheduleDeleteResponse>;
|
|
/**
|
|
* Retrieves the test schedule for a page in a specific region.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const schedule = await client.speed.schedule.get(
|
|
* 'example.com',
|
|
* { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
get(url: string, params: ScheduleGetParams, options?: Core.RequestOptions): Core.APIPromise<Schedule>;
|
|
}
|
|
/**
|
|
* The test schedule.
|
|
*/
|
|
export interface Schedule {
|
|
/**
|
|
* The frequency of the test.
|
|
*/
|
|
frequency?: 'DAILY' | 'WEEKLY';
|
|
/**
|
|
* 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';
|
|
/**
|
|
* A URL.
|
|
*/
|
|
url?: string;
|
|
}
|
|
export interface ScheduleCreateResponse {
|
|
/**
|
|
* The test schedule.
|
|
*/
|
|
schedule?: Schedule;
|
|
test?: TestsAPI.Test;
|
|
}
|
|
export interface ScheduleDeleteResponse {
|
|
/**
|
|
* Number of items affected.
|
|
*/
|
|
count?: number;
|
|
}
|
|
export interface ScheduleCreateParams {
|
|
/**
|
|
* 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 ScheduleDeleteParams {
|
|
/**
|
|
* 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 ScheduleGetParams {
|
|
/**
|
|
* 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 declare namespace ScheduleResource {
|
|
export { type Schedule as Schedule, type ScheduleCreateResponse as ScheduleCreateResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleDeleteParams as ScheduleDeleteParams, type ScheduleGetParams as ScheduleGetParams, };
|
|
}
|
|
//# sourceMappingURL=schedule.d.ts.map
|