cloudflare/resources/cache/cache-reserve.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CacheReserveAPI from 'cloudflare/resources/cache/cache-reserve';
export declare class CacheReserve extends APIResource {
    /**
     * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
     * disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
     * You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
     * that you cannot undo or cancel this operation.
     */
    clear(params: CacheReserveClearParams, options?: Core.RequestOptions): Core.APIPromise<CacheReserveClearResponse>;
    /**
     * Increase cache lifetimes by automatically storing all cacheable files into
     * Cloudflare's persistent object storage buckets. Requires Cache Reserve
     * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
     * to reduce Reserve operations costs. See the
     * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
     * for more information.
     */
    edit(params: CacheReserveEditParams, options?: Core.RequestOptions): Core.APIPromise<CacheReserveEditResponse>;
    /**
     * Increase cache lifetimes by automatically storing all cacheable files into
     * Cloudflare's persistent object storage buckets. Requires Cache Reserve
     * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
     * to reduce Reserve operations costs. See the
     * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
     * for more information.
     */
    get(params: CacheReserveGetParams, options?: Core.RequestOptions): Core.APIPromise<CacheReserveGetResponse>;
    /**
     * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
     * disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
     * You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
     * that you cannot undo or cancel this operation.
     */
    status(params: CacheReserveStatusParams, options?: Core.RequestOptions): Core.APIPromise<CacheReserveStatusResponse>;
}
/**
 * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
 * disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
 * You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
 * that you cannot undo or cancel this operation.
 */
export interface CacheReserveClearResponse {
    /**
     * ID of the zone setting.
     */
    id: 'cache_reserve_clear';
    /**
     * last time this setting was modified.
     */
    modified_on: string | null;
    /**
     * The time that the latest Cache Reserve Clear operation started.
     */
    start_ts: string;
    /**
     * The current state of the Cache Reserve Clear operation.
     */
    state: 'In-progress' | 'Completed';
    /**
     * The time that the latest Cache Reserve Clear operation completed.
     */
    end_ts?: string;
}
/**
 * Increase cache lifetimes by automatically storing all cacheable files into
 * Cloudflare's persistent object storage buckets. Requires Cache Reserve
 * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
 * to reduce Reserve operations costs. See the
 * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
 * for more information.
 */
export interface CacheReserveEditResponse {
    /**
     * ID of the zone setting.
     */
    id: 'cache_reserve';
    /**
     * last time this setting was modified.
     */
    modified_on: string | null;
    /**
     * Value of the Cache Reserve zone setting.
     */
    value: 'on' | 'off';
}
/**
 * Increase cache lifetimes by automatically storing all cacheable files into
 * Cloudflare's persistent object storage buckets. Requires Cache Reserve
 * subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
 * to reduce Reserve operations costs. See the
 * [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
 * for more information.
 */
export interface CacheReserveGetResponse {
    /**
     * ID of the zone setting.
     */
    id: 'cache_reserve';
    /**
     * last time this setting was modified.
     */
    modified_on: string | null;
    /**
     * Value of the Cache Reserve zone setting.
     */
    value: 'on' | 'off';
}
/**
 * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
 * disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
 * You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
 * that you cannot undo or cancel this operation.
 */
export interface CacheReserveStatusResponse {
    /**
     * ID of the zone setting.
     */
    id: 'cache_reserve_clear';
    /**
     * last time this setting was modified.
     */
    modified_on: string | null;
    /**
     * The time that the latest Cache Reserve Clear operation started.
     */
    start_ts: string;
    /**
     * The current state of the Cache Reserve Clear operation.
     */
    state: 'In-progress' | 'Completed';
    /**
     * The time that the latest Cache Reserve Clear operation completed.
     */
    end_ts?: string;
}
export interface CacheReserveClearParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export interface CacheReserveEditParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Body param: Value of the Cache Reserve zone setting.
     */
    value: 'on' | 'off';
}
export interface CacheReserveGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export interface CacheReserveStatusParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace CacheReserve {
    export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse;
    export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse;
    export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse;
    export import CacheReserveStatusResponse = CacheReserveAPI.CacheReserveStatusResponse;
    export import CacheReserveClearParams = CacheReserveAPI.CacheReserveClearParams;
    export import CacheReserveEditParams = CacheReserveAPI.CacheReserveEditParams;
    export import CacheReserveGetParams = CacheReserveAPI.CacheReserveGetParams;
    export import CacheReserveStatusParams = CacheReserveAPI.CacheReserveStatusParams;
}
//# sourceMappingURL=cache-reserve.d.ts.map