cloudflare/resources/cache/smart-tiered-cache.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
export declare class SmartTieredCache extends APIResource {
    /**
     * Smart Tiered Cache dynamically selects the single closest upper tier for each of
     * your website’s origins with no configuration required, using our in-house
     * performance and routing data. Cloudflare collects latency data for each request
     * to an origin, and uses the latency data to determine how well any upper-tier
     * data center is connected with an origin. As a result, Cloudflare can select the
     * data center with the lowest latency to be the upper-tier for an origin.
     *
     * @example
     * ```ts
     * const smartTieredCache =
     *   await client.cache.smartTieredCache.delete({
     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    delete(params: SmartTieredCacheDeleteParams, options?: Core.RequestOptions): Core.APIPromise<SmartTieredCacheDeleteResponse>;
    /**
     * Smart Tiered Cache dynamically selects the single closest upper tier for each of
     * your website’s origins with no configuration required, using our in-house
     * performance and routing data. Cloudflare collects latency data for each request
     * to an origin, and uses the latency data to determine how well any upper-tier
     * data center is connected with an origin. As a result, Cloudflare can select the
     * data center with the lowest latency to be the upper-tier for an origin.
     *
     * @example
     * ```ts
     * const response = await client.cache.smartTieredCache.edit({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   value: 'on',
     * });
     * ```
     */
    edit(params: SmartTieredCacheEditParams, options?: Core.RequestOptions): Core.APIPromise<SmartTieredCacheEditResponse>;
    /**
     * Smart Tiered Cache dynamically selects the single closest upper tier for each of
     * your website’s origins with no configuration required, using our in-house
     * performance and routing data. Cloudflare collects latency data for each request
     * to an origin, and uses the latency data to determine how well any upper-tier
     * data center is connected with an origin. As a result, Cloudflare can select the
     * data center with the lowest latency to be the upper-tier for an origin.
     *
     * @example
     * ```ts
     * const smartTieredCache =
     *   await client.cache.smartTieredCache.get({
     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    get(params: SmartTieredCacheGetParams, options?: Core.RequestOptions): Core.APIPromise<SmartTieredCacheGetResponse>;
}
export interface SmartTieredCacheDeleteResponse {
    /**
     * The identifier of the caching setting.
     */
    id: 'tiered_cache_smart_topology_enable';
    /**
     * Whether the setting is editable.
     */
    editable: boolean;
    /**
     * Last time this setting was modified.
     */
    modified_on?: string | null;
}
export interface SmartTieredCacheEditResponse {
    /**
     * The identifier of the caching setting.
     */
    id: 'tiered_cache_smart_topology_enable';
    /**
     * Whether the setting is editable.
     */
    editable: boolean;
    /**
     * Value of the Smart Tiered Cache zone setting.
     */
    value: 'on' | 'off';
    /**
     * Last time this setting was modified.
     */
    modified_on?: string | null;
}
export interface SmartTieredCacheGetResponse {
    /**
     * The identifier of the caching setting.
     */
    id: 'tiered_cache_smart_topology_enable';
    /**
     * Whether the setting is editable.
     */
    editable: boolean;
    /**
     * Value of the Smart Tiered Cache zone setting.
     */
    value: 'on' | 'off';
    /**
     * Last time this setting was modified.
     */
    modified_on?: string | null;
}
export interface SmartTieredCacheDeleteParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export interface SmartTieredCacheEditParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Body param: Enable or disable the Smart Tiered Cache.
     */
    value: 'on' | 'off';
}
export interface SmartTieredCacheGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace SmartTieredCache {
    export { type SmartTieredCacheDeleteResponse as SmartTieredCacheDeleteResponse, type SmartTieredCacheEditResponse as SmartTieredCacheEditResponse, type SmartTieredCacheGetResponse as SmartTieredCacheGetResponse, type SmartTieredCacheDeleteParams as SmartTieredCacheDeleteParams, type SmartTieredCacheEditParams as SmartTieredCacheEditParams, type SmartTieredCacheGetParams as SmartTieredCacheGetParams, };
}
//# sourceMappingURL=smart-tiered-cache.d.ts.map