cloudflare/resources/zones/settings/cache-level.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CacheLevelAPI from 'cloudflare/resources/zones/settings/cache-level';
export declare class CacheLevelResource extends APIResource {
    /**
     * Cache Level functions based off the setting level. The basic setting will cache
     * most static resources (i.e., css, images, and JavaScript). The simplified
     * setting will ignore the query string when delivering a cached resource. The
     * aggressive setting will cache all static resources, including ones with a query
     * string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
     */
    edit(params: CacheLevelEditParams, options?: Core.RequestOptions): Core.APIPromise<CacheLevel>;
    /**
     * Cache Level functions based off the setting level. The basic setting will cache
     * most static resources (i.e., css, images, and JavaScript). The simplified
     * setting will ignore the query string when delivering a cached resource. The
     * aggressive setting will cache all static resources, including ones with a query
     * string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
     */
    get(params: CacheLevelGetParams, options?: Core.RequestOptions): Core.APIPromise<CacheLevel>;
}
/**
 * Cache Level functions based off the setting level. The basic setting will cache
 * most static resources (i.e., css, images, and JavaScript). The simplified
 * setting will ignore the query string when delivering a cached resource. The
 * aggressive setting will cache all static resources, including ones with a query
 * string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
 */
export interface CacheLevel {
    /**
     * ID of the zone setting.
     */
    id: 'cache_level';
    /**
     * Current value of the zone setting.
     */
    value: 'aggressive' | 'basic' | 'simplified';
    /**
     * Whether or not this setting can be modified for this zone (based on your
     * Cloudflare plan level).
     */
    editable?: true | false;
    /**
     * last time this setting was modified.
     */
    modified_on?: string | null;
}
export interface CacheLevelEditParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Body param: Value of the zone setting.
     */
    value: 'aggressive' | 'basic' | 'simplified';
}
export interface CacheLevelGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace CacheLevelResource {
    export import CacheLevel = CacheLevelAPI.CacheLevel;
    export import CacheLevelEditParams = CacheLevelAPI.CacheLevelEditParams;
    export import CacheLevelGetParams = CacheLevelAPI.CacheLevelGetParams;
}
//# sourceMappingURL=cache-level.d.ts.map