import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; import * as IssuesAPI from "./issues.js"; import { V4PagePagination, type V4PagePaginationParams } from "../../../pagination.js"; export declare class Issues extends APIResource { /** * Lists all Security Center issues for the account, showing active security * problems requiring attention. * * @deprecated */ list(params: IssueListParams, options?: Core.RequestOptions): Core.PagePromise; /** * Retrieves Security Center issue counts aggregated by classification class. * * @deprecated */ class(params: IssueClassParams, options?: Core.RequestOptions): Core.APIPromise; /** * Deprecated endpoint for archiving Security Center insights. Use the newer * archive-security-center-insight endpoint instead. * * @deprecated */ dismiss(issueId: string, params: IssueDismissParams, options?: Core.RequestOptions): Core.APIPromise; /** * Retrieves Security Center issue counts aggregated by severity level. * * @deprecated */ severity(params: IssueSeverityParams, options?: Core.RequestOptions): Core.APIPromise; /** * Retrieves Security Center issue counts aggregated by issue type. * * @deprecated */ type(params: IssueTypeParams, options?: Core.RequestOptions): Core.APIPromise; } export declare class IssueListResponsesV4PagePagination extends V4PagePagination { } export type IssueType = 'compliance_violation' | 'email_security' | 'exposed_infrastructure' | 'insecure_configuration' | 'weak_authentication' | 'configuration_suggestion'; export type IssueTypeParam = 'compliance_violation' | 'email_security' | 'exposed_infrastructure' | 'insecure_configuration' | 'weak_authentication' | 'configuration_suggestion'; export type SeverityQueryParam = 'low' | 'moderate' | 'critical'; export type SeverityQueryParamParam = 'low' | 'moderate' | 'critical'; export interface IssueListResponse { /** * Indicates the total number of results. */ count?: number; issues?: Array; /** * Specifies the current page within paginated list of results. */ page?: number; /** * Sets the number of results per page of results. */ per_page?: number; } export declare namespace IssueListResponse { interface Issue { id?: string; dismissed?: boolean; /** * Indicates whether the insight has a large payload that requires fetching via the * context endpoint. */ has_extended_context?: boolean; issue_class?: string; issue_type?: IssuesAPI.IssueType; payload?: Issue.Payload; resolve_link?: string; resolve_text?: string; severity?: 'Low' | 'Moderate' | 'Critical'; since?: string; /** * The current status of the insight. */ status?: 'active' | 'resolved'; subject?: string; timestamp?: string; /** * User-defined classification for the insight. Can be 'false_positive', * 'accept_risk', 'other', or null. */ user_classification?: 'false_positive' | 'accept_risk' | 'other' | null; } namespace Issue { interface Payload { /** * Describes the method used to detect insight. */ detection_method?: string; zone_tag?: string; } } } export type IssueClassResponse = Array; export declare namespace IssueClassResponse { interface IssueClassResponseItem { count?: number; value?: string; } } export interface IssueDismissResponse { errors: Array; messages: Array; /** * Whether the API call was successful. */ success: true; } export declare namespace IssueDismissResponse { interface Error { code: number; message: string; documentation_url?: string; source?: Error.Source; } namespace Error { interface Source { pointer?: string; } } interface Message { code: number; message: string; documentation_url?: string; source?: Message.Source; } namespace Message { interface Source { pointer?: string; } } } export type IssueSeverityResponse = Array; export declare namespace IssueSeverityResponse { interface IssueSeverityResponseItem { count?: number; value?: string; } } export type IssueTypeResponse = Array; export declare namespace IssueTypeResponse { interface IssueTypeResponseItem { count?: number; value?: string; } } export interface IssueListParams extends V4PagePaginationParams { /** * Path param: Identifier. */ account_id: string; /** * Query param */ dismissed?: boolean; /** * Query param */ issue_class?: Array; /** * Query param */ 'issue_class~neq'?: Array; /** * Query param */ issue_type?: Array; /** * Query param */ 'issue_type~neq'?: Array; /** * Query param */ product?: Array; /** * Query param */ 'product~neq'?: Array; /** * Query param */ severity?: Array; /** * Query param */ 'severity~neq'?: Array; /** * Query param */ subject?: Array; /** * Query param */ 'subject~neq'?: Array; } export interface IssueClassParams { /** * Path param: Identifier. */ account_id: string; /** * Query param */ dismissed?: boolean; /** * Query param */ issue_class?: Array; /** * Query param */ 'issue_class~neq'?: Array; /** * Query param */ issue_type?: Array; /** * Query param */ 'issue_type~neq'?: Array; /** * Query param */ product?: Array; /** * Query param */ 'product~neq'?: Array; /** * Query param */ severity?: Array; /** * Query param */ 'severity~neq'?: Array; /** * Query param */ subject?: Array; /** * Query param */ 'subject~neq'?: Array; } export interface IssueDismissParams { /** * Path param: Identifier. */ account_id: string; /** * Body param */ dismiss?: boolean; } export interface IssueSeverityParams { /** * Path param: Identifier. */ account_id: string; /** * Query param */ dismissed?: boolean; /** * Query param */ issue_class?: Array; /** * Query param */ 'issue_class~neq'?: Array; /** * Query param */ issue_type?: Array; /** * Query param */ 'issue_type~neq'?: Array; /** * Query param */ product?: Array; /** * Query param */ 'product~neq'?: Array; /** * Query param */ severity?: Array; /** * Query param */ 'severity~neq'?: Array; /** * Query param */ subject?: Array; /** * Query param */ 'subject~neq'?: Array; } export interface IssueTypeParams { /** * Path param: Identifier. */ account_id: string; /** * Query param */ dismissed?: boolean; /** * Query param */ issue_class?: Array; /** * Query param */ 'issue_class~neq'?: Array; /** * Query param */ issue_type?: Array; /** * Query param */ 'issue_type~neq'?: Array; /** * Query param */ product?: Array; /** * Query param */ 'product~neq'?: Array; /** * Query param */ severity?: Array; /** * Query param */ 'severity~neq'?: Array; /** * Query param */ subject?: Array; /** * Query param */ 'subject~neq'?: Array; } export declare namespace Issues { export { type IssueType as IssueType, type SeverityQueryParam as SeverityQueryParam, type IssueListResponse as IssueListResponse, type IssueClassResponse as IssueClassResponse, type IssueDismissResponse as IssueDismissResponse, type IssueSeverityResponse as IssueSeverityResponse, type IssueTypeResponse as IssueTypeResponse, IssueListResponsesV4PagePagination as IssueListResponsesV4PagePagination, type IssueListParams as IssueListParams, type IssueClassParams as IssueClassParams, type IssueDismissParams as IssueDismissParams, type IssueSeverityParams as IssueSeverityParams, type IssueTypeParams as IssueTypeParams, }; } //# sourceMappingURL=issues.d.ts.map