@datadog/datadog-api-client

import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi"; import { Configuration } from "../../datadog-api-client-common/configuration"; import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http"; import { AssetType } from "../models/AssetType"; import { BulkMuteFindingsRequest } from "../models/BulkMuteFindingsRequest"; import { BulkMuteFindingsResponse } from "../models/BulkMuteFindingsResponse"; import { ConvertJobResultsToSignalsRequest } from "../models/ConvertJobResultsToSignalsRequest"; import { CreateCustomFrameworkRequest } from "../models/CreateCustomFrameworkRequest"; import { CreateCustomFrameworkResponse } from "../models/CreateCustomFrameworkResponse"; import { CreateNotificationRuleParameters } from "../models/CreateNotificationRuleParameters"; import { DeleteCustomFrameworkResponse } from "../models/DeleteCustomFrameworkResponse"; import { Finding } from "../models/Finding"; import { FindingEvaluation } from "../models/FindingEvaluation"; import { FindingStatus } from "../models/FindingStatus"; import { FindingVulnerabilityType } from "../models/FindingVulnerabilityType"; import { GetCustomFrameworkResponse } from "../models/GetCustomFrameworkResponse"; import { GetFindingResponse } from "../models/GetFindingResponse"; import { GetResourceEvaluationFiltersResponse } from "../models/GetResourceEvaluationFiltersResponse"; import { GetRuleVersionHistoryResponse } from "../models/GetRuleVersionHistoryResponse"; import { GetSBOMResponse } from "../models/GetSBOMResponse"; import { HistoricalJobResponse } from "../models/HistoricalJobResponse"; import { JobCreateResponse } from "../models/JobCreateResponse"; import { ListAssetsSBOMsResponse } from "../models/ListAssetsSBOMsResponse"; import { ListFindingsResponse } from "../models/ListFindingsResponse"; import { ListHistoricalJobsResponse } from "../models/ListHistoricalJobsResponse"; import { ListVulnerabilitiesResponse } from "../models/ListVulnerabilitiesResponse"; import { ListVulnerableAssetsResponse } from "../models/ListVulnerableAssetsResponse"; import { NotificationRuleResponse } from "../models/NotificationRuleResponse"; import { PatchNotificationRuleParameters } from "../models/PatchNotificationRuleParameters"; import { RunHistoricalJobRequest } from "../models/RunHistoricalJobRequest"; import { SBOMComponentLicenseType } from "../models/SBOMComponentLicenseType"; import { SecurityFilterCreateRequest } from "../models/SecurityFilterCreateRequest"; import { SecurityFilterResponse } from "../models/SecurityFilterResponse"; import { SecurityFiltersResponse } from "../models/SecurityFiltersResponse"; import { SecurityFilterUpdateRequest } from "../models/SecurityFilterUpdateRequest"; import { SecurityMonitoringListRulesResponse } from "../models/SecurityMonitoringListRulesResponse"; import { SecurityMonitoringRuleConvertPayload } from "../models/SecurityMonitoringRuleConvertPayload"; import { SecurityMonitoringRuleConvertResponse } from "../models/SecurityMonitoringRuleConvertResponse"; import { SecurityMonitoringRuleCreatePayload } from "../models/SecurityMonitoringRuleCreatePayload"; import { SecurityMonitoringRuleResponse } from "../models/SecurityMonitoringRuleResponse"; import { SecurityMonitoringRuleTestRequest } from "../models/SecurityMonitoringRuleTestRequest"; import { SecurityMonitoringRuleTestResponse } from "../models/SecurityMonitoringRuleTestResponse"; import { SecurityMonitoringRuleUpdatePayload } from "../models/SecurityMonitoringRuleUpdatePayload"; import { SecurityMonitoringRuleValidatePayload } from "../models/SecurityMonitoringRuleValidatePayload"; import { SecurityMonitoringSignal } from "../models/SecurityMonitoringSignal"; import { SecurityMonitoringSignalAssigneeUpdateRequest } from "../models/SecurityMonitoringSignalAssigneeUpdateRequest"; import { SecurityMonitoringSignalIncidentsUpdateRequest } from "../models/SecurityMonitoringSignalIncidentsUpdateRequest"; import { SecurityMonitoringSignalListRequest } from "../models/SecurityMonitoringSignalListRequest"; import { SecurityMonitoringSignalResponse } from "../models/SecurityMonitoringSignalResponse"; import { SecurityMonitoringSignalsListResponse } from "../models/SecurityMonitoringSignalsListResponse"; import { SecurityMonitoringSignalsSort } from "../models/SecurityMonitoringSignalsSort"; import { SecurityMonitoringSignalStateUpdateRequest } from "../models/SecurityMonitoringSignalStateUpdateRequest"; import { SecurityMonitoringSignalTriageUpdateResponse } from "../models/SecurityMonitoringSignalTriageUpdateResponse"; import { SecurityMonitoringSuppressionCreateRequest } from "../models/SecurityMonitoringSuppressionCreateRequest"; import { SecurityMonitoringSuppressionResponse } from "../models/SecurityMonitoringSuppressionResponse"; import { SecurityMonitoringSuppressionsResponse } from "../models/SecurityMonitoringSuppressionsResponse"; import { SecurityMonitoringSuppressionUpdateRequest } from "../models/SecurityMonitoringSuppressionUpdateRequest"; import { UpdateCustomFrameworkRequest } from "../models/UpdateCustomFrameworkRequest"; import { UpdateCustomFrameworkResponse } from "../models/UpdateCustomFrameworkResponse"; import { UpdateResourceEvaluationFiltersRequest } from "../models/UpdateResourceEvaluationFiltersRequest"; import { UpdateResourceEvaluationFiltersResponse } from "../models/UpdateResourceEvaluationFiltersResponse"; import { VulnerabilityEcosystem } from "../models/VulnerabilityEcosystem"; import { VulnerabilitySeverity } from "../models/VulnerabilitySeverity"; import { VulnerabilityStatus } from "../models/VulnerabilityStatus"; import { VulnerabilityTool } from "../models/VulnerabilityTool"; import { VulnerabilityType } from "../models/VulnerabilityType"; export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory { cancelHistoricalJob(jobId: string, _options?: Configuration): Promise<RequestContext>; convertExistingSecurityMonitoringRule(ruleId: string, _options?: Configuration): Promise<RequestContext>; convertJobResultToSignal(body: ConvertJobResultsToSignalsRequest, _options?: Configuration): Promise<RequestContext>; convertSecurityMonitoringRuleFromJSONToTerraform(body: SecurityMonitoringRuleConvertPayload, _options?: Configuration): Promise<RequestContext>; createCustomFramework(body: CreateCustomFrameworkRequest, _options?: Configuration): Promise<RequestContext>; createSecurityFilter(body: SecurityFilterCreateRequest, _options?: Configuration): Promise<RequestContext>; createSecurityMonitoringRule(body: SecurityMonitoringRuleCreatePayload, _options?: Configuration): Promise<RequestContext>; createSecurityMonitoringSuppression(body: SecurityMonitoringSuppressionCreateRequest, _options?: Configuration): Promise<RequestContext>; createSignalNotificationRule(body: CreateNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>; createVulnerabilityNotificationRule(body: CreateNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>; deleteCustomFramework(handle: string, version: string, _options?: Configuration): Promise<RequestContext>; deleteHistoricalJob(jobId: string, _options?: Configuration): Promise<RequestContext>; deleteSecurityFilter(securityFilterId: string, _options?: Configuration): Promise<RequestContext>; deleteSecurityMonitoringRule(ruleId: string, _options?: Configuration): Promise<RequestContext>; deleteSecurityMonitoringSuppression(suppressionId: string, _options?: Configuration): Promise<RequestContext>; deleteSignalNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>; deleteVulnerabilityNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>; editSecurityMonitoringSignalAssignee(signalId: string, body: SecurityMonitoringSignalAssigneeUpdateRequest, _options?: Configuration): Promise<RequestContext>; editSecurityMonitoringSignalIncidents(signalId: string, body: SecurityMonitoringSignalIncidentsUpdateRequest, _options?: Configuration): Promise<RequestContext>; editSecurityMonitoringSignalState(signalId: string, body: SecurityMonitoringSignalStateUpdateRequest, _options?: Configuration): Promise<RequestContext>; getCustomFramework(handle: string, version: string, _options?: Configuration): Promise<RequestContext>; getFinding(findingId: string, snapshotTimestamp?: number, _options?: Configuration): Promise<RequestContext>; getHistoricalJob(jobId: string, _options?: Configuration): Promise<RequestContext>; getResourceEvaluationFilters(cloudProvider?: string, accountId?: string, skipCache?: boolean, _options?: Configuration): Promise<RequestContext>; getRuleVersionHistory(ruleId: string, pageSize?: number, pageNumber?: number, _options?: Configuration): Promise<RequestContext>; getSBOM(assetType: AssetType, filterAssetName: string, filterRepoDigest?: string, _options?: Configuration): Promise<RequestContext>; getSecurityFilter(securityFilterId: string, _options?: Configuration): Promise<RequestContext>; getSecurityMonitoringRule(ruleId: string, _options?: Configuration): Promise<RequestContext>; getSecurityMonitoringSignal(signalId: string, _options?: Configuration): Promise<RequestContext>; getSecurityMonitoringSuppression(suppressionId: string, _options?: Configuration): Promise<RequestContext>; getSignalNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>; getSignalNotificationRules(_options?: Configuration): Promise<RequestContext>; getVulnerabilityNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>; getVulnerabilityNotificationRules(_options?: Configuration): Promise<RequestContext>; listAssetsSBOMs(pageToken?: string, pageNumber?: number, filterAssetType?: AssetType, filterAssetName?: string, filterPackageName?: string, filterPackageVersion?: string, filterLicenseName?: string, filterLicenseType?: SBOMComponentLicenseType, _options?: Configuration): Promise<RequestContext>; listFindings(pageLimit?: number, snapshotTimestamp?: number, pageCursor?: string, filterTags?: string, filterEvaluationChangedAt?: string, filterMuted?: boolean, filterRuleId?: string, filterRuleName?: string, filterResourceType?: string, filterDiscoveryTimestamp?: string, filterEvaluation?: FindingEvaluation, filterStatus?: FindingStatus, filterVulnerabilityType?: Array<FindingVulnerabilityType>, detailedFindings?: boolean, _options?: Configuration): Promise<RequestContext>; listHistoricalJobs(pageSize?: number, pageNumber?: number, sort?: string, filterQuery?: string, _options?: Configuration): Promise<RequestContext>; listSecurityFilters(_options?: Configuration): Promise<RequestContext>; listSecurityMonitoringRules(pageSize?: number, pageNumber?: number, _options?: Configuration): Promise<RequestContext>; listSecurityMonitoringSignals(filterQuery?: string, filterFrom?: Date, filterTo?: Date, sort?: SecurityMonitoringSignalsSort, pageCursor?: string, pageLimit?: number, _options?: Configuration): Promise<RequestContext>; listSecurityMonitoringSuppressions(_options?: Configuration): Promise<RequestContext>; listVulnerabilities(pageToken?: string, pageNumber?: number, filterType?: VulnerabilityType, filterCvssBaseScoreOp?: number, filterCvssBaseSeverity?: VulnerabilitySeverity, filterCvssBaseVector?: string, filterCvssDatadogScoreOp?: number, filterCvssDatadogSeverity?: VulnerabilitySeverity, filterCvssDatadogVector?: string, filterStatus?: VulnerabilityStatus, filterTool?: VulnerabilityTool, filterLibraryName?: string, filterLibraryVersion?: string, filterAdvisoryId?: string, filterRisksExploitationProbability?: boolean, filterRisksPocExploitAvailable?: boolean, filterRisksExploitAvailable?: boolean, filterRisksEpssScoreOp?: number, filterRisksEpssSeverity?: VulnerabilitySeverity, filterLanguage?: string, filterEcosystem?: VulnerabilityEcosystem, filterCodeLocationLocation?: string, filterCodeLocationFilePath?: string, filterCodeLocationMethod?: string, filterFixAvailable?: boolean, filterRepoDigests?: string, filterOrigin?: string, filterAssetName?: string, filterAssetType?: AssetType, filterAssetVersionFirst?: string, filterAssetVersionLast?: string, filterAssetRepositoryUrl?: string, filterAssetRisksInProduction?: boolean, filterAssetRisksUnderAttack?: boolean, filterAssetRisksIsPubliclyAccessible?: boolean, filterAssetRisksHasPrivilegedAccess?: boolean, filterAssetRisksHasAccessToSensitiveData?: boolean, filterAssetEnvironments?: string, filterAssetTeams?: string, filterAssetArch?: string, filterAssetOperatingSystemName?: string, filterAssetOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>; listVulnerableAssets(pageToken?: string, pageNumber?: number, filterName?: string, filterType?: AssetType, filterVersionFirst?: string, filterVersionLast?: string, filterRepositoryUrl?: string, filterRisksInProduction?: boolean, filterRisksUnderAttack?: boolean, filterRisksIsPubliclyAccessible?: boolean, filterRisksHasPrivilegedAccess?: boolean, filterRisksHasAccessToSensitiveData?: boolean, filterEnvironments?: string, filterTeams?: string, filterArch?: string, filterOperatingSystemName?: string, filterOperatingSystemVersion?: string, _options?: Configuration): Promise<RequestContext>; muteFindings(body: BulkMuteFindingsRequest, _options?: Configuration): Promise<RequestContext>; patchSignalNotificationRule(id: string, body: PatchNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>; patchVulnerabilityNotificationRule(id: string, body: PatchNotificationRuleParameters, _options?: Configuration): Promise<RequestContext>; runHistoricalJob(body: RunHistoricalJobRequest, _options?: Configuration): Promise<RequestContext>; searchSecurityMonitoringSignals(body?: SecurityMonitoringSignalListRequest, _options?: Configuration): Promise<RequestContext>; testExistingSecurityMonitoringRule(ruleId: string, body: SecurityMonitoringRuleTestRequest, _options?: Configuration): Promise<RequestContext>; testSecurityMonitoringRule(body: SecurityMonitoringRuleTestRequest, _options?: Configuration): Promise<RequestContext>; updateCustomFramework(handle: string, version: string, body: UpdateCustomFrameworkRequest, _options?: Configuration): Promise<RequestContext>; updateResourceEvaluationFilters(body: UpdateResourceEvaluationFiltersRequest, _options?: Configuration): Promise<RequestContext>; updateSecurityFilter(securityFilterId: string, body: SecurityFilterUpdateRequest, _options?: Configuration): Promise<RequestContext>; updateSecurityMonitoringRule(ruleId: string, body: SecurityMonitoringRuleUpdatePayload, _options?: Configuration): Promise<RequestContext>; updateSecurityMonitoringSuppression(suppressionId: string, body: SecurityMonitoringSuppressionUpdateRequest, _options?: Configuration): Promise<RequestContext>; validateSecurityMonitoringRule(body: SecurityMonitoringRuleValidatePayload, _options?: Configuration): Promise<RequestContext>; } export declare class SecurityMonitoringApiResponseProcessor { /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to cancelHistoricalJob * @throws ApiException if the response code was not in [200, 299] */ cancelHistoricalJob(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to convertExistingSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ convertExistingSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleConvertResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to convertJobResultToSignal * @throws ApiException if the response code was not in [200, 299] */ convertJobResultToSignal(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to convertSecurityMonitoringRuleFromJSONToTerraform * @throws ApiException if the response code was not in [200, 299] */ convertSecurityMonitoringRuleFromJSONToTerraform(response: ResponseContext): Promise<SecurityMonitoringRuleConvertResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createCustomFramework * @throws ApiException if the response code was not in [200, 299] */ createCustomFramework(response: ResponseContext): Promise<CreateCustomFrameworkResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSecurityFilter * @throws ApiException if the response code was not in [200, 299] */ createSecurityFilter(response: ResponseContext): Promise<SecurityFilterResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ createSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSecurityMonitoringSuppression * @throws ApiException if the response code was not in [200, 299] */ createSecurityMonitoringSuppression(response: ResponseContext): Promise<SecurityMonitoringSuppressionResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSignalNotificationRule * @throws ApiException if the response code was not in [200, 299] */ createSignalNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createVulnerabilityNotificationRule * @throws ApiException if the response code was not in [200, 299] */ createVulnerabilityNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteCustomFramework * @throws ApiException if the response code was not in [200, 299] */ deleteCustomFramework(response: ResponseContext): Promise<DeleteCustomFrameworkResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteHistoricalJob * @throws ApiException if the response code was not in [200, 299] */ deleteHistoricalJob(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSecurityFilter * @throws ApiException if the response code was not in [200, 299] */ deleteSecurityFilter(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ deleteSecurityMonitoringRule(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSecurityMonitoringSuppression * @throws ApiException if the response code was not in [200, 299] */ deleteSecurityMonitoringSuppression(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSignalNotificationRule * @throws ApiException if the response code was not in [200, 299] */ deleteSignalNotificationRule(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteVulnerabilityNotificationRule * @throws ApiException if the response code was not in [200, 299] */ deleteVulnerabilityNotificationRule(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to editSecurityMonitoringSignalAssignee * @throws ApiException if the response code was not in [200, 299] */ editSecurityMonitoringSignalAssignee(response: ResponseContext): Promise<SecurityMonitoringSignalTriageUpdateResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to editSecurityMonitoringSignalIncidents * @throws ApiException if the response code was not in [200, 299] */ editSecurityMonitoringSignalIncidents(response: ResponseContext): Promise<SecurityMonitoringSignalTriageUpdateResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to editSecurityMonitoringSignalState * @throws ApiException if the response code was not in [200, 299] */ editSecurityMonitoringSignalState(response: ResponseContext): Promise<SecurityMonitoringSignalTriageUpdateResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getCustomFramework * @throws ApiException if the response code was not in [200, 299] */ getCustomFramework(response: ResponseContext): Promise<GetCustomFrameworkResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getFinding * @throws ApiException if the response code was not in [200, 299] */ getFinding(response: ResponseContext): Promise<GetFindingResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getHistoricalJob * @throws ApiException if the response code was not in [200, 299] */ getHistoricalJob(response: ResponseContext): Promise<HistoricalJobResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getResourceEvaluationFilters * @throws ApiException if the response code was not in [200, 299] */ getResourceEvaluationFilters(response: ResponseContext): Promise<GetResourceEvaluationFiltersResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getRuleVersionHistory * @throws ApiException if the response code was not in [200, 299] */ getRuleVersionHistory(response: ResponseContext): Promise<GetRuleVersionHistoryResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSBOM * @throws ApiException if the response code was not in [200, 299] */ getSBOM(response: ResponseContext): Promise<GetSBOMResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSecurityFilter * @throws ApiException if the response code was not in [200, 299] */ getSecurityFilter(response: ResponseContext): Promise<SecurityFilterResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ getSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSecurityMonitoringSignal * @throws ApiException if the response code was not in [200, 299] */ getSecurityMonitoringSignal(response: ResponseContext): Promise<SecurityMonitoringSignalResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSecurityMonitoringSuppression * @throws ApiException if the response code was not in [200, 299] */ getSecurityMonitoringSuppression(response: ResponseContext): Promise<SecurityMonitoringSuppressionResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSignalNotificationRule * @throws ApiException if the response code was not in [200, 299] */ getSignalNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSignalNotificationRules * @throws ApiException if the response code was not in [200, 299] */ getSignalNotificationRules(response: ResponseContext): Promise<any>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getVulnerabilityNotificationRule * @throws ApiException if the response code was not in [200, 299] */ getVulnerabilityNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getVulnerabilityNotificationRules * @throws ApiException if the response code was not in [200, 299] */ getVulnerabilityNotificationRules(response: ResponseContext): Promise<any>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listAssetsSBOMs * @throws ApiException if the response code was not in [200, 299] */ listAssetsSBOMs(response: ResponseContext): Promise<ListAssetsSBOMsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listFindings * @throws ApiException if the response code was not in [200, 299] */ listFindings(response: ResponseContext): Promise<ListFindingsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listHistoricalJobs * @throws ApiException if the response code was not in [200, 299] */ listHistoricalJobs(response: ResponseContext): Promise<ListHistoricalJobsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSecurityFilters * @throws ApiException if the response code was not in [200, 299] */ listSecurityFilters(response: ResponseContext): Promise<SecurityFiltersResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSecurityMonitoringRules * @throws ApiException if the response code was not in [200, 299] */ listSecurityMonitoringRules(response: ResponseContext): Promise<SecurityMonitoringListRulesResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSecurityMonitoringSignals * @throws ApiException if the response code was not in [200, 299] */ listSecurityMonitoringSignals(response: ResponseContext): Promise<SecurityMonitoringSignalsListResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSecurityMonitoringSuppressions * @throws ApiException if the response code was not in [200, 299] */ listSecurityMonitoringSuppressions(response: ResponseContext): Promise<SecurityMonitoringSuppressionsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listVulnerabilities * @throws ApiException if the response code was not in [200, 299] */ listVulnerabilities(response: ResponseContext): Promise<ListVulnerabilitiesResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listVulnerableAssets * @throws ApiException if the response code was not in [200, 299] */ listVulnerableAssets(response: ResponseContext): Promise<ListVulnerableAssetsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to muteFindings * @throws ApiException if the response code was not in [200, 299] */ muteFindings(response: ResponseContext): Promise<BulkMuteFindingsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to patchSignalNotificationRule * @throws ApiException if the response code was not in [200, 299] */ patchSignalNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to patchVulnerabilityNotificationRule * @throws ApiException if the response code was not in [200, 299] */ patchVulnerabilityNotificationRule(response: ResponseContext): Promise<NotificationRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to runHistoricalJob * @throws ApiException if the response code was not in [200, 299] */ runHistoricalJob(response: ResponseContext): Promise<JobCreateResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to searchSecurityMonitoringSignals * @throws ApiException if the response code was not in [200, 299] */ searchSecurityMonitoringSignals(response: ResponseContext): Promise<SecurityMonitoringSignalsListResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to testExistingSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ testExistingSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleTestResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to testSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ testSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleTestResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateCustomFramework * @throws ApiException if the response code was not in [200, 299] */ updateCustomFramework(response: ResponseContext): Promise<UpdateCustomFrameworkResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateResourceEvaluationFilters * @throws ApiException if the response code was not in [200, 299] */ updateResourceEvaluationFilters(response: ResponseContext): Promise<UpdateResourceEvaluationFiltersResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateSecurityFilter * @throws ApiException if the response code was not in [200, 299] */ updateSecurityFilter(response: ResponseContext): Promise<SecurityFilterResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ updateSecurityMonitoringRule(response: ResponseContext): Promise<SecurityMonitoringRuleResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateSecurityMonitoringSuppression * @throws ApiException if the response code was not in [200, 299] */ updateSecurityMonitoringSuppression(response: ResponseContext): Promise<SecurityMonitoringSuppressionResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to validateSecurityMonitoringRule * @throws ApiException if the response code was not in [200, 299] */ validateSecurityMonitoringRule(response: ResponseContext): Promise<void>; } export interface SecurityMonitoringApiCancelHistoricalJobRequest { /** * The ID of the job. * @type string */ jobId: string; } export interface SecurityMonitoringApiConvertExistingSecurityMonitoringRuleRequest { /** * The ID of the rule. * @type string */ ruleId: string; } export interface SecurityMonitoringApiConvertJobResultToSignalRequest { /** * @type ConvertJobResultsToSignalsRequest */ body: ConvertJobResultsToSignalsRequest; } export interface SecurityMonitoringApiConvertSecurityMonitoringRuleFromJSONToTerraformRequest { /** * @type SecurityMonitoringRuleConvertPayload */ body: SecurityMonitoringRuleConvertPayload; } export interface SecurityMonitoringApiCreateCustomFrameworkRequest { /** * @type CreateCustomFrameworkRequest */ body: CreateCustomFrameworkRequest; } export interface SecurityMonitoringApiCreateSecurityFilterRequest { /** * The definition of the new security filter. * @type SecurityFilterCreateRequest */ body: SecurityFilterCreateRequest; } export interface SecurityMonitoringApiCreateSecurityMonitoringRuleRequest { /** * @type SecurityMonitoringRuleCreatePayload */ body: SecurityMonitoringRuleCreatePayload; } export interface SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest { /** * The definition of the new suppression rule. * @type SecurityMonitoringSuppressionCreateRequest */ body: SecurityMonitoringSuppressionCreateRequest; } export interface SecurityMonitoringApiCreateSignalNotificationRuleRequest { /** * The body of the create notification rule request is composed of the rule type and the rule attributes: * the rule name, the selectors, the notification targets, and the rule enabled status. * @type CreateNotificationRuleParameters */ body: CreateNotificationRuleParameters; } export interface SecurityMonitoringApiCreateVulnerabilityNotificationRuleRequest { /** * The body of the create notification rule request is composed of the rule type and the rule attributes: * the rule name, the selectors, the notification targets, and the rule enabled status. * @type CreateNotificationRuleParameters */ body: CreateNotificationRuleParameters; } export interface SecurityMonitoringApiDeleteCustomFrameworkRequest { /** * The framework handle * @type string */ handle: string; /** * The framework version * @type string */ version: string; } export interface SecurityMonitoringApiDeleteHistoricalJobRequest { /** * The ID of the job. * @type string */ jobId: string; } export interface SecurityMonitoringApiDeleteSecurityFilterRequest { /** * The ID of the security filter. * @type string */ securityFilterId: string; } export interface SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest { /** * The ID of the rule. * @type string */ ruleId: string; } export interface SecurityMonitoringApiDeleteSecurityMonitoringSuppressionRequest { /** * The ID of the suppression rule * @type string */ suppressionId: string; } export interface SecurityMonitoringApiDeleteSignalNotificationRuleRequest { /** * ID of the notification rule. * @type string */ id: string; } export interface SecurityMonitoringApiDeleteVulnerabilityNotificationRuleRequest { /** * ID of the notification rule. * @type string */ id: string; } export interface SecurityMonitoringApiEditSecurityMonitoringSignalAssigneeRequest { /** * The ID of the signal. * @type string */ signalId: string; /** * Attributes describing the signal update. * @type SecurityMonitoringSignalAssigneeUpdateRequest */ body: SecurityMonitoringSignalAssigneeUpdateRequest; } export interface SecurityMonitoringApiEditSecurityMonitoringSignalIncidentsRequest { /** * The ID of the signal. * @type string */ signalId: string; /** * Attributes describing the signal update. * @type SecurityMonitoringSignalIncidentsUpdateRequest */ body: SecurityMonitoringSignalIncidentsUpdateRequest; } export interface SecurityMonitoringApiEditSecurityMonitoringSignalStateRequest { /** * The ID of the signal. * @type string */ signalId: string; /** * Attributes describing the signal update. * @type SecurityMonitoringSignalStateUpdateRequest */ body: SecurityMonitoringSignalStateUpdateRequest; } export interface SecurityMonitoringApiGetCustomFrameworkRequest { /** * The framework handle * @type string */ handle: string; /** * The framework version * @type string */ version: string; } export interface SecurityMonitoringApiGetFindingRequest { /** * The ID of the finding. * @type string */ findingId: string; /** * Return the finding for a given snapshot of time (Unix ms). * @type number */ snapshotTimestamp?: number; } export interface SecurityMonitoringApiGetHistoricalJobRequest { /** * The ID of the job. * @type string */ jobId: string; } export interface SecurityMonitoringApiGetResourceEvaluationFiltersRequest { /** * Filter resource filters by cloud provider (e.g. aws, gcp, azure). * @type string */ cloudProvider?: string; /** * Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified. * @type string */ accountId?: string; /** * Skip cache for resource filters. * @type boolean */ skipCache?: boolean; } export interface SecurityMonitoringApiGetRuleVersionHistoryRequest { /** * The ID of the rule. * @type string */ ruleId: string; /** * Size for a given page. The maximum allowed value is 100. * @type number */ pageSize?: number; /** * Specific page number to return. * @type number */ pageNumber?: number; } export interface SecurityMonitoringApiGetSBOMRequest { /** * The type of the asset for the SBOM request. * @type AssetType */ assetType: AssetType; /** * The name of the asset for the SBOM request. * @type string */ filterAssetName: string; /** * The container image `repo_digest` for the SBOM request. When the requested asset type is 'Image', this filter is mandatory. * @type string */ filterRepoDigest?: string; } export interface SecurityMonitoringApiGetSecurityFilterRequest { /** * The ID of the security filter. * @type string */ securityFilterId: string; } export interface SecurityMonitoringApiGetSecurityMonitoringRuleRequest { /** * The ID of the rule. * @type string */ ruleId: string; } export interface SecurityMonitoringApiGetSecurityMonitoringSignalRequest { /** * The ID of the signal. * @type string */ signalId: string; } export interface SecurityMonitoringApiGetSecurityMonitoringSuppressionRequest { /** * The ID of the suppression rule * @type string */ suppressionId: string; } export interface SecurityMonitoringApiGetSignalNotificationRuleRequest { /** * ID of the notification rule. * @type string */ id: string; } export interface SecurityMonitoringApiGetVulnerabilityNotificationRuleRequest { /** * ID of the notification rule. * @type string */ id: string; } export interface SecurityMonitoringApiListAssetsSBOMsRequest { /** * Its value must come from the `links` section of the response of the first request. Do not manually edit it. * @type string */ pageToken?: string; /** * The page number to be retrieved. It should be equal to or greater than 1. * @type number */ pageNumber?: number; /** * The type of the assets for the SBOM request. * @type AssetType */ filterAssetType?: AssetType; /** * The name of the asset for the SBOM request. * @type string */ filterAssetName?: string; /** * The name of the component that is a dependency of an asset. * @type string */ filterPackageName?: string; /** * The version of the component that is a dependency of an asset. * @type string */ filterPackageVersion?: string; /** * The software license name of the component that is a dependency of an asset. * @type string */ filterLicenseName?: string; /** * The software license type of the component that is a dependency of an asset. * @type SBOMComponentLicenseType */ filterLicenseType?: SBOMComponentLicenseType; } export interface SecurityMonitoringApiListFindingsRequest { /** * Limit the number of findings returned. Must be <= 1000. * @type number */ pageLimit?: number; /** * Return findings for a given snapshot of time (Unix ms). * @type number */ snapshotTimestamp?: number; /** * Return the next page of findings pointed to by the cursor. * @type string */ pageCursor?: string; /** * Return findings that have these associated tags (repeatable). * @type string */ filterTags?: string; /** * Return findings that have changed from pass to fail or vice versa on a specified date (Unix ms) or date range (using comparison operators). * @type string */ filterEvaluationChangedAt?: string; /** * Set to `true` to return findings that are muted. Set to `false` to return unmuted findings. * @type boolean */ filterMuted?: boolean; /** * Return findings for the specified rule ID. * @type string */ filterRuleId?: string; /** * Return findings for the specified rule. * @type string */ filterRuleName?: string; /** * Return only findings for the specified resource type. * @type string */ filterResourceType?: string; /** * Return findings that were found on a specified date (Unix ms)