cloudflare/resources/zero-trust/dlp/profiles/predefined.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as PredefinedAPI from 'cloudflare/resources/zero-trust/dlp/profiles/predefined';
export declare class Predefined extends APIResource {
    /**
     * Updates a DLP predefined profile. Only supports enabling/disabling entries.
     */
    update(profileId: string, params: PredefinedUpdateParams, options?: Core.RequestOptions): Core.APIPromise<DLPPredefinedProfile>;
    /**
     * Fetches a predefined DLP profile.
     */
    get(profileId: string, params: PredefinedGetParams, options?: Core.RequestOptions): Core.APIPromise<DLPPredefinedProfile>;
}
export interface DLPPredefinedProfile {
    /**
     * The ID for this profile
     */
    id?: string;
    /**
     * Related DLP policies will trigger when the match count exceeds the number set.
     */
    allowed_match_count?: number;
    /**
     * Scan the context of predefined entries to only return matches surrounded by
     * keywords.
     */
    context_awareness?: DLPPredefinedProfile.ContextAwareness;
    /**
     * The entries for this profile.
     */
    entries?: Array<DLPPredefinedProfile.Entry>;
    /**
     * The name of the profile.
     */
    name?: string;
    /**
     * If true, scan images via OCR to determine if any text present matches filters.
     */
    ocr_enabled?: boolean;
    /**
     * The type of the profile.
     */
    type?: 'predefined';
}
export declare namespace DLPPredefinedProfile {
    /**
     * Scan the context of predefined entries to only return matches surrounded by
     * keywords.
     */
    interface ContextAwareness {
        /**
         * If true, scan the context of predefined entries to only return matches
         * surrounded by keywords.
         */
        enabled: boolean;
        /**
         * Content types to exclude from context analysis and return all matches.
         */
        skip: ContextAwareness.Skip;
    }
    namespace ContextAwareness {
        /**
         * Content types to exclude from context analysis and return all matches.
         */
        interface Skip {
            /**
             * If the content type is a file, skip context analysis and return all matches.
             */
            files: boolean;
        }
    }
    /**
     * A predefined entry that matches a profile
     */
    interface Entry {
        /**
         * The ID for this entry
         */
        id?: string;
        /**
         * Whether the entry is enabled or not.
         */
        enabled?: boolean;
        /**
         * The name of the entry.
         */
        name?: string;
        /**
         * ID of the parent profile
         */
        profile_id?: unknown;
    }
}
export interface PredefinedUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: Related DLP policies will trigger when the match count exceeds the
     * number set.
     */
    allowed_match_count?: number;
    /**
     * Body param: Scan the context of predefined entries to only return matches
     * surrounded by keywords.
     */
    context_awareness?: PredefinedUpdateParams.ContextAwareness;
    /**
     * Body param: The entries for this profile.
     */
    entries?: Array<PredefinedUpdateParams.Entry>;
    /**
     * Body param: If true, scan images via OCR to determine if any text present
     * matches filters.
     */
    ocr_enabled?: boolean;
}
export declare namespace PredefinedUpdateParams {
    /**
     * Scan the context of predefined entries to only return matches surrounded by
     * keywords.
     */
    interface ContextAwareness {
        /**
         * If true, scan the context of predefined entries to only return matches
         * surrounded by keywords.
         */
        enabled: boolean;
        /**
         * Content types to exclude from context analysis and return all matches.
         */
        skip: ContextAwareness.Skip;
    }
    namespace ContextAwareness {
        /**
         * Content types to exclude from context analysis and return all matches.
         */
        interface Skip {
            /**
             * If the content type is a file, skip context analysis and return all matches.
             */
            files: boolean;
        }
    }
    interface Entry {
        /**
         * Whether the entry is enabled or not.
         */
        enabled?: boolean;
    }
}
export interface PredefinedGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace Predefined {
    export import DLPPredefinedProfile = PredefinedAPI.DLPPredefinedProfile;
    export import PredefinedUpdateParams = PredefinedAPI.PredefinedUpdateParams;
    export import PredefinedGetParams = PredefinedAPI.PredefinedGetParams;
}
//# sourceMappingURL=predefined.d.ts.map