cloudflare
Version:
The official TypeScript library for the Cloudflare API
91 lines • 2.42 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import * as IssuesAPI from "../../intel/attack-surface-report/issues.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseType extends APIResource {
static readonly _key: readonly ['securityCenter', 'insights', 'type'];
/**
* Retrieves Security Center insight counts aggregated by insight type.
*
* @example
* ```ts
* const types = await client.securityCenter.insights.type.get(
* { account_id: 'account_id' },
* );
* ```
*/
get(params?: TypeGetParams | null | undefined, options?: RequestOptions): APIPromise<TypeGetResponse>;
}
export declare class Type extends BaseType {
}
export type TypeGetResponse = Array<TypeGetResponse.TypeGetResponseItem>;
export declare namespace TypeGetResponse {
interface TypeGetResponseItem {
count?: number;
value?: string;
}
}
export interface TypeGetParams {
/**
* Path param: The Account ID to use for this endpoint. Mutually exclusive with the
* Zone ID.
*/
account_id?: string;
/**
* Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
* Account ID.
*/
zone_id?: string;
/**
* Query param
*/
dismissed?: boolean;
/**
* Query param
*/
issue_class?: Array<string>;
/**
* Query param
*/
'issue_class~neq'?: Array<string>;
/**
* Query param
*/
issue_type?: Array<IssuesAPI.IssueTypeParam>;
/**
* Query param
*/
'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;
/**
* Query param
*/
product?: Array<string>;
/**
* Query param
*/
'product~neq'?: Array<string>;
/**
* Query param
*/
severity?: Array<IssuesAPI.SeverityQueryParamParam>;
/**
* Query param
*/
'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;
/**
* Query param
*/
source?: Array<'cloudflare' | 'riskrecon'>;
/**
* Query param
*/
subject?: Array<string>;
/**
* Query param
*/
'subject~neq'?: Array<string>;
}
export declare namespace Type {
export { type TypeGetResponse as TypeGetResponse, type TypeGetParams as TypeGetParams };
}
//# sourceMappingURL=type.d.mts.map