cloudflare
Version:
The official TypeScript library for the Cloudflare API
46 lines • 1.51 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseCategories extends APIResource {
static readonly _key: readonly ['cloudforceOne', 'threatSignals', 'categories'];
/**
* Lists the predefined categories that can be assigned to feeds.
*
* @example
* ```ts
* const categories =
* await client.cloudforceOne.threatSignals.categories.list({
* account_id: 'account_id',
* });
* ```
*/
list(params: CategoryListParams, options?: RequestOptions): APIPromise<CategoryListResponse>;
}
export declare class Categories extends BaseCategories {
}
export interface CategoryListResponse {
categories: Array<CategoryListResponse.Category>;
}
export declare namespace CategoryListResponse {
interface Category {
/**
* Wire value accepted by the feed `category_id` field.
*/
id: string;
/**
* Plain-language description of the category.
*/
description: string;
/**
* Human-readable display label.
*/
name: string;
}
}
export interface CategoryListParams {
account_id: string;
}
export declare namespace Categories {
export { type CategoryListResponse as CategoryListResponse, type CategoryListParams as CategoryListParams };
}
//# sourceMappingURL=categories.d.mts.map