cloudflare
Version:
The official TypeScript library for the Cloudflare API
77 lines • 2.55 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { SinglePage } from "../../../pagination.js";
export declare class Categories extends APIResource {
/**
* Fetches a list of all categories.
*/
list(params: CategoryListParams, options?: Core.RequestOptions): Core.PagePromise<CategoriesSinglePage, Category>;
}
export declare class CategoriesSinglePage extends SinglePage<Category> {
}
export interface Category {
/**
* The identifier for this category. There is only one category per ID.
*/
id?: number;
/**
* True if the category is in beta and subject to change.
*/
beta?: boolean;
/**
* Which account types are allowed to create policies based on this category.
* `blocked` categories are blocked unconditionally for all accounts.
* `removalPending` categories can be removed from policies but not added.
* `noBlock` categories cannot be blocked.
*/
class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
/**
* A short summary of domains in the category.
*/
description?: string;
/**
* The name of the category.
*/
name?: string;
/**
* All subcategories for this category.
*/
subcategories?: Array<Category.Subcategory>;
}
export declare namespace Category {
interface Subcategory {
/**
* The identifier for this category. There is only one category per ID.
*/
id?: number;
/**
* True if the category is in beta and subject to change.
*/
beta?: boolean;
/**
* Which account types are allowed to create policies based on this category.
* `blocked` categories are blocked unconditionally for all accounts.
* `removalPending` categories can be removed from policies but not added.
* `noBlock` categories cannot be blocked.
*/
class?: 'free' | 'premium' | 'blocked' | 'removalPending' | 'noBlock';
/**
* A short summary of domains in the category.
*/
description?: string;
/**
* The name of the category.
*/
name?: string;
}
}
export interface CategoryListParams {
/**
* Identifier
*/
account_id: string;
}
export declare namespace Categories {
export { type Category as Category, CategoriesSinglePage as CategoriesSinglePage, type CategoryListParams as CategoryListParams, };
}
//# sourceMappingURL=categories.d.ts.map