@datadog/datadog-api-client 1.30.0 → 1.31.0

package/dist/packages/datadog-api-client-v2/apis/SecurityMonitoringApi.d.ts

@@ -3,12 +3,17 @@ import { Configuration } from "../../datadog-api-client-common/configuration";
 import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
 import { BulkMuteFindingsRequest } from "../models/BulkMuteFindingsRequest";
 import { BulkMuteFindingsResponse } from "../models/BulkMuteFindingsResponse";
+import { ConvertJobResultsToSignalsRequest } from "../models/ConvertJobResultsToSignalsRequest";
 import { Finding } from "../models/Finding";
 import { FindingEvaluation } from "../models/FindingEvaluation";
 import { FindingStatus } from "../models/FindingStatus";
 import { FindingVulnerabilityType } from "../models/FindingVulnerabilityType";
 import { GetFindingResponse } from "../models/GetFindingResponse";
+import { HistoricalJobResponse } from "../models/HistoricalJobResponse";
+import { JobCreateResponse } from "../models/JobCreateResponse";
 import { ListFindingsResponse } from "../models/ListFindingsResponse";
+import { ListHistoricalJobsResponse } from "../models/ListHistoricalJobsResponse";
+import { RunHistoricalJobRequest } from "../models/RunHistoricalJobRequest";
 import { SecurityFilterCreateRequest } from "../models/SecurityFilterCreateRequest";
 import { SecurityFilterResponse } from "../models/SecurityFilterResponse";
 import { SecurityFiltersResponse } from "../models/SecurityFiltersResponse";
@@ -36,11 +41,14 @@ import { SecurityMonitoringSuppressionResponse } from "../models/SecurityMonitor
 import { SecurityMonitoringSuppressionsResponse } from "../models/SecurityMonitoringSuppressionsResponse";
 import { SecurityMonitoringSuppressionUpdateRequest } from "../models/SecurityMonitoringSuppressionUpdateRequest";
 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>;
     createSecurityFilter(body: SecurityFilterCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createSecurityMonitoringRule(body: SecurityMonitoringRuleCreatePayload, _options?: Configuration): Promise<RequestContext>;
     createSecurityMonitoringSuppression(body: SecurityMonitoringSuppressionCreateRequest, _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>;
@@ -48,16 +56,19 @@ export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestF
     editSecurityMonitoringSignalIncidents(signalId: string, body: SecurityMonitoringSignalIncidentsUpdateRequest, _options?: Configuration): Promise<RequestContext>;
     editSecurityMonitoringSignalState(signalId: string, body: SecurityMonitoringSignalStateUpdateRequest, _options?: Configuration): Promise<RequestContext>;
     getFinding(findingId: string, snapshotTimestamp?: number, _options?: Configuration): Promise<RequestContext>;
+    getHistoricalJob(jobId: 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>;
     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>, _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>;
     muteFindings(body: BulkMuteFindingsRequest, _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>;
@@ -67,6 +78,14 @@ export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestF
     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
@@ -75,6 +94,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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
@@ -107,6 +134,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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 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
@@ -163,6 +198,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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
@@ -203,6 +246,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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
@@ -243,6 +294,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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 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
@@ -300,6 +359,13 @@ export declare class SecurityMonitoringApiResponseProcessor {
      */
     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.
@@ -307,6 +373,12 @@ export interface SecurityMonitoringApiConvertExistingSecurityMonitoringRuleReque
      */
     ruleId: string;
 }
+export interface SecurityMonitoringApiConvertJobResultToSignalRequest {
+    /**
+     * @type ConvertJobResultsToSignalsRequest
+     */
+    body: ConvertJobResultsToSignalsRequest;
+}
 export interface SecurityMonitoringApiConvertSecurityMonitoringRuleFromJSONToTerraformRequest {
     /**
      * @type SecurityMonitoringRuleConvertPayload
@@ -333,6 +405,13 @@ export interface SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest
      */
     body: SecurityMonitoringSuppressionCreateRequest;
 }
+export interface SecurityMonitoringApiDeleteHistoricalJobRequest {
+    /**
+     * The ID of the job.
+     * @type string
+     */
+    jobId: string;
+}
 export interface SecurityMonitoringApiDeleteSecurityFilterRequest {
     /**
      * The ID of the security filter.
@@ -402,6 +481,13 @@ export interface SecurityMonitoringApiGetFindingRequest {
      */
     snapshotTimestamp?: number;
 }
+export interface SecurityMonitoringApiGetHistoricalJobRequest {
+    /**
+     * The ID of the job.
+     * @type string
+     */
+    jobId: string;
+}
 export interface SecurityMonitoringApiGetSecurityFilterRequest {
     /**
      * The ID of the security filter.
@@ -497,6 +583,28 @@ export interface SecurityMonitoringApiListFindingsRequest {
      */
     filterVulnerabilityType?: Array<FindingVulnerabilityType>;
 }
+export interface SecurityMonitoringApiListHistoricalJobsRequest {
+    /**
+     * Size for a given page. The maximum allowed value is 100.
+     * @type number
+     */
+    pageSize?: number;
+    /**
+     * Specific page number to return.
+     * @type number
+     */
+    pageNumber?: number;
+    /**
+     * The order of the jobs in results.
+     * @type string
+     */
+    sort?: string;
+    /**
+     * Query used to filter items from the fetched list.
+     * @type string
+     */
+    filterQuery?: string;
+}
 export interface SecurityMonitoringApiListSecurityMonitoringRulesRequest {
     /**
      * Size for a given page. The maximum allowed value is 100.
@@ -557,6 +665,12 @@ export interface SecurityMonitoringApiMuteFindingsRequest {
      */
     body: BulkMuteFindingsRequest;
 }
+export interface SecurityMonitoringApiRunHistoricalJobRequest {
+    /**
+     * @type RunHistoricalJobRequest
+     */
+    body: RunHistoricalJobRequest;
+}
 export interface SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest {
     /**
      * @type SecurityMonitoringSignalListRequest
@@ -626,12 +740,22 @@ export declare class SecurityMonitoringApi {
     private responseProcessor;
     private configuration;
     constructor(configuration: Configuration, requestFactory?: SecurityMonitoringApiRequestFactory, responseProcessor?: SecurityMonitoringApiResponseProcessor);
+    /**
+     * Cancel a historical job.
+     * @param param The request object
+     */
+    cancelHistoricalJob(param: SecurityMonitoringApiCancelHistoricalJobRequest, options?: Configuration): Promise<void>;
     /**
      * Convert an existing rule from JSON to Terraform for datadog provider
      * resource datadog_security_monitoring_rule.
      * @param param The request object
      */
     convertExistingSecurityMonitoringRule(param: SecurityMonitoringApiConvertExistingSecurityMonitoringRuleRequest, options?: Configuration): Promise<SecurityMonitoringRuleConvertResponse>;
+    /**
+     * Convert a job result to a signal.
+     * @param param The request object
+     */
+    convertJobResultToSignal(param: SecurityMonitoringApiConvertJobResultToSignalRequest, options?: Configuration): Promise<void>;
     /**
      * Convert a rule that doesn't (yet) exist from JSON to Terraform for datadog provider
      * resource datadog_security_monitoring_rule.
@@ -656,6 +780,11 @@ export declare class SecurityMonitoringApi {
      * @param param The request object
      */
     createSecurityMonitoringSuppression(param: SecurityMonitoringApiCreateSecurityMonitoringSuppressionRequest, options?: Configuration): Promise<SecurityMonitoringSuppressionResponse>;
+    /**
+     * Delete an existing job.
+     * @param param The request object
+     */
+    deleteHistoricalJob(param: SecurityMonitoringApiDeleteHistoricalJobRequest, options?: Configuration): Promise<void>;
     /**
      * Delete a specific security filter.
      * @param param The request object
@@ -691,6 +820,11 @@ export declare class SecurityMonitoringApi {
      * @param param The request object
      */
     getFinding(param: SecurityMonitoringApiGetFindingRequest, options?: Configuration): Promise<GetFindingResponse>;
+    /**
+     * Get a job's details.
+     * @param param The request object
+     */
+    getHistoricalJob(param: SecurityMonitoringApiGetHistoricalJobRequest, options?: Configuration): Promise<HistoricalJobResponse>;
     /**
      * Get the details of a specific security filter.
      *
@@ -715,7 +849,9 @@ export declare class SecurityMonitoringApi {
      */
     getSecurityMonitoringSuppression(param: SecurityMonitoringApiGetSecurityMonitoringSuppressionRequest, options?: Configuration): Promise<SecurityMonitoringSuppressionResponse>;
     /**
-     * Get a list of CSPM findings.
+     * Get a list of findings. These include both misconfigurations and identity risks.
+     *
+     * **Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`
      *
      * ### Filtering
      *
@@ -752,6 +888,11 @@ export declare class SecurityMonitoringApi {
      * Provide a paginated version of listFindings returning a generator with all the items.
      */
     listFindingsWithPagination(param?: SecurityMonitoringApiListFindingsRequest, options?: Configuration): AsyncGenerator<Finding>;
+    /**
+     * List historical jobs.
+     * @param param The request object
+     */
+    listHistoricalJobs(param?: SecurityMonitoringApiListHistoricalJobsRequest, options?: Configuration): Promise<ListHistoricalJobsResponse>;
     /**
      * Get the list of configured security filters with their definitions.
      * @param param The request object
@@ -783,6 +924,11 @@ export declare class SecurityMonitoringApi {
      * @param param The request object
      */
     muteFindings(param: SecurityMonitoringApiMuteFindingsRequest, options?: Configuration): Promise<BulkMuteFindingsResponse>;
+    /**
+     * Run a historical job.
+     * @param param The request object
+     */
+    runHistoricalJob(param: SecurityMonitoringApiRunHistoricalJobRequest, options?: Configuration): Promise<JobCreateResponse>;
     /**
      * Returns security signals that match a search query.
      * Both this endpoint and the GET endpoint can be used interchangeably for listing