cloudflare/resources/ai-audit/robots.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 BaseRobots extends APIResource {
    static readonly _key: readonly ['aiAudit', 'robots'];
    /**
     * Fetches and parses robots.txt files for multiple domains within a zone in a
     * single request. Each domain must belong to the specified zone. Results are keyed
     * by hostname.
     *
     * @example
     * ```ts
     * const response = await client.aiAudit.robots.bulkGet({
     *   zone_id: 'zone_id',
     *   body: ['example.com', 'blog.example.com'],
     * });
     * ```
     */
    bulkGet(params: RobotBulkGetParams, options?: RequestOptions): APIPromise<RobotBulkGetResponse>;
    /**
     * Fetches and parses the robots.txt file for a zone or a specific subdomain within
     * the zone. Returns parsed user-agent rules, content signals, and sitemaps.
     *
     * @example
     * ```ts
     * const robot = await client.aiAudit.robots.get({
     *   zone_id: 'zone_id',
     * });
     * ```
     */
    get(params: RobotGetParams, options?: RequestOptions): APIPromise<RobotGetResponse>;
}
export declare class Robots extends BaseRobots {
}
/**
 * Map of hostname to parsed robots.txt rules.
 */
export type RobotBulkGetResponse = {
    [key: string]: RobotBulkGetResponse.item;
};
export declare namespace RobotBulkGetResponse {
    /**
     * Parsed robots.txt rules for a single domain.
     */
    interface item {
        /**
         * Map of user-agent string to its parsed rules.
         */
        userAgents: {
            [key: string]: item.UserAgents;
        };
        /**
         * List of sitemap URLs found in robots.txt.
         */
        sitemaps?: Array<string>;
        /**
         * HTTP status code from fetching the robots.txt file.
         */
        status?: number;
    }
    namespace item {
        /**
         * Parsed rules for a specific user-agent.
         */
        interface UserAgents {
            /**
             * List of allowed path patterns.
             */
            allow: Array<string>;
            /**
             * List of disallowed path patterns.
             */
            disallow: Array<string>;
            /**
             * Content signal directives from robots.txt.
             */
            contentSignals?: UserAgents.ContentSignals;
            /**
             * Crawl delay in seconds.
             */
            crawlDelay?: number;
        }
        namespace UserAgents {
            /**
             * Content signal directives from robots.txt.
             */
            interface ContentSignals {
                /**
                 * Whether AI input usage is permitted.
                 */
                'ai-input'?: 'yes' | 'no';
                /**
                 * Whether AI training is permitted.
                 */
                'ai-train'?: 'yes' | 'no';
                /**
                 * Whether search indexing is permitted.
                 */
                search?: 'yes' | 'no';
            }
        }
    }
}
/**
 * Parsed robots.txt rules for a single domain.
 */
export interface RobotGetResponse {
    /**
     * Map of user-agent string to its parsed rules.
     */
    userAgents: {
        [key: string]: RobotGetResponse.UserAgents;
    };
    /**
     * List of sitemap URLs found in robots.txt.
     */
    sitemaps?: Array<string>;
    /**
     * HTTP status code from fetching the robots.txt file.
     */
    status?: number;
}
export declare namespace RobotGetResponse {
    /**
     * Parsed rules for a specific user-agent.
     */
    interface UserAgents {
        /**
         * List of allowed path patterns.
         */
        allow: Array<string>;
        /**
         * List of disallowed path patterns.
         */
        disallow: Array<string>;
        /**
         * Content signal directives from robots.txt.
         */
        contentSignals?: UserAgents.ContentSignals;
        /**
         * Crawl delay in seconds.
         */
        crawlDelay?: number;
    }
    namespace UserAgents {
        /**
         * Content signal directives from robots.txt.
         */
        interface ContentSignals {
            /**
             * Whether AI input usage is permitted.
             */
            'ai-input'?: 'yes' | 'no';
            /**
             * Whether AI training is permitted.
             */
            'ai-train'?: 'yes' | 'no';
            /**
             * Whether search indexing is permitted.
             */
            search?: 'yes' | 'no';
        }
    }
}
export interface RobotBulkGetParams {
    /**
     * Path param: Identifier of the zone.
     */
    zone_id: string;
    /**
     * Body param: Array of domain hostnames to fetch robots.txt for. Each domain must
     * end with the zone name. Maximum 25 domains per request.
     */
    body: Array<string>;
}
export interface RobotGetParams {
    /**
     * Path param: Identifier of the zone.
     */
    zone_id: string;
    /**
     * Query param: Optional subdomain to fetch robots.txt for. If omitted, fetches
     * robots.txt for the zone apex domain.
     */
    subdomain?: string;
}
export declare namespace Robots {
    export { type RobotBulkGetResponse as RobotBulkGetResponse, type RobotGetResponse as RobotGetResponse, type RobotBulkGetParams as RobotBulkGetParams, type RobotGetParams as RobotGetParams, };
}
//# sourceMappingURL=robots.d.ts.map