cloudflare/resources/managed-transforms/managed-transforms.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseManagedTransforms extends APIResource {
    static readonly _key: readonly ['managedTransforms'];
    /**
     * Fetches a list of all Managed Transforms.
     */
    list(params: ManagedTransformListParams, options?: RequestOptions): APIPromise<ManagedTransformListResponse>;
    /**
     * Disables all Managed Transforms.
     */
    delete(params: ManagedTransformDeleteParams, options?: RequestOptions): APIPromise<void>;
    /**
     * Updates the status of one or more Managed Transforms.
     */
    edit(params: ManagedTransformEditParams, options?: RequestOptions): APIPromise<ManagedTransformEditResponse>;
}
export declare class ManagedTransforms extends BaseManagedTransforms {
}
/**
 * A result.
 */
export interface ManagedTransformListResponse {
    /**
     * The list of Managed Request Transforms.
     */
    managed_request_headers: Array<ManagedTransformListResponse.ManagedRequestHeader>;
    /**
     * The list of Managed Response Transforms.
     */
    managed_response_headers: Array<ManagedTransformListResponse.ManagedResponseHeader>;
}
export declare namespace ManagedTransformListResponse {
    /**
     * A Managed Transform object.
     */
    interface ManagedRequestHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
        /**
         * Whether the Managed Transform conflicts with the currently-enabled Managed
         * Transforms.
         */
        has_conflict: boolean;
        /**
         * The Managed Transforms that this Managed Transform conflicts with.
         */
        conflicts_with?: Array<string>;
    }
    /**
     * A Managed Transform object.
     */
    interface ManagedResponseHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
        /**
         * Whether the Managed Transform conflicts with the currently-enabled Managed
         * Transforms.
         */
        has_conflict: boolean;
        /**
         * The Managed Transforms that this Managed Transform conflicts with.
         */
        conflicts_with?: Array<string>;
    }
}
/**
 * A result.
 */
export interface ManagedTransformEditResponse {
    /**
     * The list of Managed Request Transforms.
     */
    managed_request_headers: Array<ManagedTransformEditResponse.ManagedRequestHeader>;
    /**
     * The list of Managed Response Transforms.
     */
    managed_response_headers: Array<ManagedTransformEditResponse.ManagedResponseHeader>;
}
export declare namespace ManagedTransformEditResponse {
    /**
     * A Managed Transform object.
     */
    interface ManagedRequestHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
        /**
         * Whether the Managed Transform conflicts with the currently-enabled Managed
         * Transforms.
         */
        has_conflict: boolean;
        /**
         * The Managed Transforms that this Managed Transform conflicts with.
         */
        conflicts_with?: Array<string>;
    }
    /**
     * A Managed Transform object.
     */
    interface ManagedResponseHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
        /**
         * Whether the Managed Transform conflicts with the currently-enabled Managed
         * Transforms.
         */
        has_conflict: boolean;
        /**
         * The Managed Transforms that this Managed Transform conflicts with.
         */
        conflicts_with?: Array<string>;
    }
}
export interface ManagedTransformListParams {
    /**
     * The unique ID of the zone.
     */
    zone_id: string;
}
export interface ManagedTransformDeleteParams {
    /**
     * The unique ID of the zone.
     */
    zone_id: string;
}
export interface ManagedTransformEditParams {
    /**
     * Path param: The unique ID of the zone.
     */
    zone_id: string;
    /**
     * Body param: The list of Managed Request Transforms.
     */
    managed_request_headers?: Array<ManagedTransformEditParams.ManagedRequestHeader>;
    /**
     * Body param: The list of Managed Response Transforms.
     */
    managed_response_headers?: Array<ManagedTransformEditParams.ManagedResponseHeader>;
}
export declare namespace ManagedTransformEditParams {
    /**
     * A Managed Transform object.
     */
    interface ManagedRequestHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
    }
    /**
     * A Managed Transform object.
     */
    interface ManagedResponseHeader {
        /**
         * The human-readable identifier of the Managed Transform.
         */
        id: string;
        /**
         * Whether the Managed Transform is enabled.
         */
        enabled: boolean;
    }
}
export declare namespace ManagedTransforms {
    export { type ManagedTransformListResponse as ManagedTransformListResponse, type ManagedTransformEditResponse as ManagedTransformEditResponse, type ManagedTransformListParams as ManagedTransformListParams, type ManagedTransformDeleteParams as ManagedTransformDeleteParams, type ManagedTransformEditParams as ManagedTransformEditParams, };
}
//# sourceMappingURL=managed-transforms.d.ts.map