cloudflare/resources/zero-trust/gateway/categories.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { SinglePage } from "../../../pagination.js";
export declare class Categories extends APIResource {
    /**
     * List all categories.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const category of client.zeroTrust.gateway.categories.list(
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * )) {
     *   // ...
     * }
     * ```
     */
    list(params: CategoryListParams, options?: Core.RequestOptions): Core.PagePromise<CategoriesSinglePage, Category>;
}
export declare class CategoriesSinglePage extends SinglePage<Category> {
}
export interface Category {
    /**
     * Identify this category. Only one category per ID.
     */
    id?: number;
    /**
     * Indicate whether the category is in beta and subject to change.
     */
    beta?: boolean;
    /**
     * Specify which account types can create policies for this category. `blocked`
     * Blocks unconditionally for all accounts. `removalPending` Allows removal from
     * policies but disables addition. `noBlock` Prevents blocking.
     */
    class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
    /**
     * Provide a short summary of domains in the category.
     */
    description?: string;
    /**
     * Specify the category name.
     */
    name?: string;
    /**
     * Provide all subcategories for this category.
     */
    subcategories?: Array<Category.Subcategory>;
}
export declare namespace Category {
    interface Subcategory {
        /**
         * Identify this category. Only one category per ID.
         */
        id?: number;
        /**
         * Indicate whether the category is in beta and subject to change.
         */
        beta?: boolean;
        /**
         * Specify which account types can create policies for this category. `blocked`
         * Blocks unconditionally for all accounts. `removalPending` Allows removal from
         * policies but disables addition. `noBlock` Prevents blocking.
         */
        class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
        /**
         * Provide a short summary of domains in the category.
         */
        description?: string;
        /**
         * Specify the category name.
         */
        name?: string;
    }
}
export interface CategoryListParams {
    /**
     * Provide the identifier string.
     */
    account_id: string;
}
export declare namespace Categories {
    export { type Category as Category, CategoriesSinglePage as CategoriesSinglePage, type CategoryListParams as CategoryListParams, };
}
//# sourceMappingURL=categories.d.ts.map