import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; import * as IssuesAPI from "../../intel/attack-surface-report/issues.js"; import * as AuditLogsAPI from "./audit-logs.js"; import { AuditLogListByInsightParams, AuditLogListByInsightResponse, AuditLogListByInsightResponsesCursorPagination, AuditLogListParams, AuditLogListResponse, AuditLogListResponsesCursorPagination, AuditLogs } from "./audit-logs.js"; import * as ClassAPI from "./class.js"; import { Class, ClassGetParams, ClassGetResponse } from "./class.js"; import * as ClassificationAPI from "./classification.js"; import { Classification, ClassificationUpdateParams, ClassificationUpdateResponse } from "./classification.js"; import * as ContextAPI from "./context.js"; import { Context, ContextGetParams, ContextGetResponse } from "./context.js"; import * as SeverityAPI from "./severity.js"; import { Severity, SeverityGetParams, SeverityGetResponse } from "./severity.js"; import * as TypeAPI from "./type.js"; import { Type, TypeGetParams, TypeGetResponse } from "./type.js"; import { V4PagePagination, type V4PagePaginationParams } from "../../../pagination.js"; export declare class Insights extends APIResource { class: ClassAPI.Class; severity: SeverityAPI.Severity; type: TypeAPI.Type; auditLogs: AuditLogsAPI.AuditLogs; classification: ClassificationAPI.Classification; context: ContextAPI.Context; /** * Lists all Security Center insights for the account or zone, showing security * findings and recommendations. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const insightListResponse of client.securityCenter.insights.list( * { account_id: 'account_id' }, * )) { * // ... * } * ``` */ list(params?: InsightListParams, options?: Core.RequestOptions): Core.PagePromise; list(options?: Core.RequestOptions): Core.PagePromise; /** * Archives a Security Center insight for an account or zone, removing it from the * active insights list while preserving historical data. * * @example * ```ts * const response = * await client.securityCenter.insights.dismiss('issue_id', { * account_id: 'account_id', * }); * ``` */ dismiss(issueId: string, params: InsightDismissParams, options?: Core.RequestOptions): Core.APIPromise; } export declare class InsightListResponsesV4PagePagination extends V4PagePagination { } export interface InsightListResponse { /** * 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 InsightListResponse { 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 interface InsightDismissResponse { errors: Array; messages: Array; /** * Whether the API call was successful. */ success: true; } export declare namespace InsightDismissResponse { 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 interface InsightListParams extends V4PagePaginationParams { /** * 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; /** * 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 InsightDismissParams { /** * 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; /** * Body param */ dismiss?: boolean; } export declare namespace Insights { export { type InsightListResponse as InsightListResponse, type InsightDismissResponse as InsightDismissResponse, InsightListResponsesV4PagePagination as InsightListResponsesV4PagePagination, type InsightListParams as InsightListParams, type InsightDismissParams as InsightDismissParams, }; export { Class as Class, type ClassGetResponse as ClassGetResponse, type ClassGetParams as ClassGetParams }; export { Severity as Severity, type SeverityGetResponse as SeverityGetResponse, type SeverityGetParams as SeverityGetParams, }; export { Type as Type, type TypeGetResponse as TypeGetResponse, type TypeGetParams as TypeGetParams }; export { AuditLogs as AuditLogs, type AuditLogListResponse as AuditLogListResponse, type AuditLogListByInsightResponse as AuditLogListByInsightResponse, AuditLogListResponsesCursorPagination as AuditLogListResponsesCursorPagination, AuditLogListByInsightResponsesCursorPagination as AuditLogListByInsightResponsesCursorPagination, type AuditLogListParams as AuditLogListParams, type AuditLogListByInsightParams as AuditLogListByInsightParams, }; export { Classification as Classification, type ClassificationUpdateResponse as ClassificationUpdateResponse, type ClassificationUpdateParams as ClassificationUpdateParams, }; export { Context as Context, type ContextGetResponse as ContextGetResponse, type ContextGetParams as ContextGetParams, }; } //# sourceMappingURL=insights.d.ts.map