@datadog/datadog-api-client 1.47.0 → 1.48.0

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

@@ -2,15 +2,22 @@ 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 { AttachCaseRequest } from "../models/AttachCaseRequest";
+import { AttachJiraIssueRequest } from "../models/AttachJiraIssueRequest";
 import { BulkMuteFindingsRequest } from "../models/BulkMuteFindingsRequest";
 import { BulkMuteFindingsResponse } from "../models/BulkMuteFindingsResponse";
 import { CloudAssetType } from "../models/CloudAssetType";
 import { ConvertJobResultsToSignalsRequest } from "../models/ConvertJobResultsToSignalsRequest";
+import { CreateCaseRequestArray } from "../models/CreateCaseRequestArray";
 import { CreateCustomFrameworkRequest } from "../models/CreateCustomFrameworkRequest";
 import { CreateCustomFrameworkResponse } from "../models/CreateCustomFrameworkResponse";
+import { CreateJiraIssueRequestArray } from "../models/CreateJiraIssueRequestArray";
 import { CreateNotificationRuleParameters } from "../models/CreateNotificationRuleParameters";
 import { DeleteCustomFrameworkResponse } from "../models/DeleteCustomFrameworkResponse";
+import { DetachCaseRequest } from "../models/DetachCaseRequest";
 import { Finding } from "../models/Finding";
+import { FindingCaseResponse } from "../models/FindingCaseResponse";
+import { FindingCaseResponseArray } from "../models/FindingCaseResponseArray";
 import { FindingEvaluation } from "../models/FindingEvaluation";
 import { FindingStatus } from "../models/FindingStatus";
 import { FindingVulnerabilityType } from "../models/FindingVulnerabilityType";
@@ -72,11 +79,15 @@ import { VulnerabilityStatus } from "../models/VulnerabilityStatus";
 import { VulnerabilityTool } from "../models/VulnerabilityTool";
 import { VulnerabilityType } from "../models/VulnerabilityType";
 export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
+    attachCase(caseId: string, body: AttachCaseRequest, _options?: Configuration): Promise<RequestContext>;
+    attachJiraIssue(body: AttachJiraIssueRequest, _options?: Configuration): Promise<RequestContext>;
     cancelThreatHuntingJob(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>;
+    createCases(body: CreateCaseRequestArray, _options?: Configuration): Promise<RequestContext>;
     createCustomFramework(body: CreateCustomFrameworkRequest, _options?: Configuration): Promise<RequestContext>;
+    createJiraIssues(body: CreateJiraIssueRequestArray, _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>;
@@ -89,6 +100,7 @@ export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestF
     deleteSignalNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>;
     deleteThreatHuntingJob(jobId: string, _options?: Configuration): Promise<RequestContext>;
     deleteVulnerabilityNotificationRule(id: string, _options?: Configuration): Promise<RequestContext>;
+    detachCase(body: DetachCaseRequest, _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>;
@@ -140,6 +152,22 @@ export declare class SecurityMonitoringApiRequestFactory extends BaseAPIRequestF
     validateSecurityMonitoringSuppression(body: SecurityMonitoringSuppressionCreateRequest, _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 attachCase
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    attachCase(response: ResponseContext): Promise<FindingCaseResponse>;
+    /**
+     * 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 attachJiraIssue
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    attachJiraIssue(response: ResponseContext): Promise<FindingCaseResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -172,6 +200,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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 createCases
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createCases(response: ResponseContext): Promise<FindingCaseResponseArray>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -180,6 +216,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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 createJiraIssues
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createJiraIssues(response: ResponseContext): Promise<FindingCaseResponseArray>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -276,6 +320,14 @@ export declare class SecurityMonitoringApiResponseProcessor {
      * @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 detachCase
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    detachCase(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
@@ -669,6 +721,23 @@ export declare class SecurityMonitoringApiResponseProcessor {
      */
     validateSecurityMonitoringSuppression(response: ResponseContext): Promise<void>;
 }
+export interface SecurityMonitoringApiAttachCaseRequest {
+    /**
+     * The unique identifier of the case to attach security findings to
+     * @type string
+     */
+    caseId: string;
+    /**
+     * @type AttachCaseRequest
+     */
+    body: AttachCaseRequest;
+}
+export interface SecurityMonitoringApiAttachJiraIssueRequest {
+    /**
+     * @type AttachJiraIssueRequest
+     */
+    body: AttachJiraIssueRequest;
+}
 export interface SecurityMonitoringApiCancelThreatHuntingJobRequest {
     /**
      * The ID of the job.
@@ -695,12 +764,24 @@ export interface SecurityMonitoringApiConvertSecurityMonitoringRuleFromJSONToTer
      */
     body: SecurityMonitoringRuleConvertPayload;
 }
+export interface SecurityMonitoringApiCreateCasesRequest {
+    /**
+     * @type CreateCaseRequestArray
+     */
+    body: CreateCaseRequestArray;
+}
 export interface SecurityMonitoringApiCreateCustomFrameworkRequest {
     /**
      * @type CreateCustomFrameworkRequest
      */
     body: CreateCustomFrameworkRequest;
 }
+export interface SecurityMonitoringApiCreateJiraIssuesRequest {
+    /**
+     * @type CreateJiraIssueRequestArray
+     */
+    body: CreateJiraIssueRequestArray;
+}
 export interface SecurityMonitoringApiCreateSecurityFilterRequest {
     /**
      * The definition of the new security filter.
@@ -791,6 +872,12 @@ export interface SecurityMonitoringApiDeleteVulnerabilityNotificationRuleRequest
      */
     id: string;
 }
+export interface SecurityMonitoringApiDetachCaseRequest {
+    /**
+     * @type DetachCaseRequest
+     */
+    body: DetachCaseRequest;
+}
 export interface SecurityMonitoringApiEditSecurityMonitoringSignalAssigneeRequest {
     /**
      * The ID of the signal.
@@ -1721,14 +1808,29 @@ export declare class SecurityMonitoringApi {
     private responseProcessor;
     private configuration;
     constructor(configuration: Configuration, requestFactory?: SecurityMonitoringApiRequestFactory, responseProcessor?: SecurityMonitoringApiResponseProcessor);
+    /**
+     * Attach security findings to a case. You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.
+     * @param param The request object
+     */
+    attachCase(param: SecurityMonitoringApiAttachCaseRequest, options?: Configuration): Promise<FindingCaseResponse>;
+    /**
+     * Attach security findings to a Jira issue by providing the Jira issue URL. You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.
+     * @param param The request object
+     */
+    attachJiraIssue(param: SecurityMonitoringApiAttachJiraIssueRequest, options?: Configuration): Promise<FindingCaseResponse>;
     /**
      * Cancel a threat hunting job.
      * @param param The request object
      */
     cancelThreatHuntingJob(param: SecurityMonitoringApiCancelThreatHuntingJobRequest, options?: Configuration): Promise<void>;
     /**
-     * Convert an existing rule from JSON to Terraform for datadog provider
-     * resource datadog_security_monitoring_rule.
+     * Convert an existing rule from JSON to Terraform for Datadog provider
+     * resource `datadog_security_monitoring_rule`. You can do so for the following rule types:
+     * - App and API Protection
+     * - Cloud SIEM (log detection and signal correlation)
+     * - Workload Protection
+     *
+     * You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).
      * @param param The request object
      */
     convertExistingSecurityMonitoringRule(param: SecurityMonitoringApiConvertExistingSecurityMonitoringRuleRequest, options?: Configuration): Promise<SecurityMonitoringRuleConvertResponse>;
@@ -1738,16 +1840,31 @@ export declare class SecurityMonitoringApi {
      */
     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.
+     * Convert a rule that doesn't (yet) exist from JSON to Terraform for Datadog provider
+     * resource `datadog_security_monitoring_rule`. You can do so for the following rule types:
+     * - App and API Protection
+     * - Cloud SIEM (log detection and signal correlation)
+     * - Workload Protection
+     *
+     * You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).
      * @param param The request object
      */
     convertSecurityMonitoringRuleFromJSONToTerraform(param: SecurityMonitoringApiConvertSecurityMonitoringRuleFromJSONToTerraformRequest, options?: Configuration): Promise<SecurityMonitoringRuleConvertResponse>;
+    /**
+     * Create cases for security findings. You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.
+     * @param param The request object
+     */
+    createCases(param: SecurityMonitoringApiCreateCasesRequest, options?: Configuration): Promise<FindingCaseResponseArray>;
     /**
      * Create a custom framework.
      * @param param The request object
      */
     createCustomFramework(param: SecurityMonitoringApiCreateCustomFrameworkRequest, options?: Configuration): Promise<CreateCustomFrameworkResponse>;
+    /**
+     * Create Jira issues for security findings. This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.
+     * @param param The request object
+     */
+    createJiraIssues(param: SecurityMonitoringApiCreateJiraIssuesRequest, options?: Configuration): Promise<FindingCaseResponseArray>;
     /**
      * Create a security filter.
      *
@@ -1811,6 +1928,11 @@ export declare class SecurityMonitoringApi {
      * @param param The request object
      */
     deleteVulnerabilityNotificationRule(param: SecurityMonitoringApiDeleteVulnerabilityNotificationRuleRequest, options?: Configuration): Promise<void>;
+    /**
+     * Detach security findings from their case. This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.
+     * @param param The request object
+     */
+    detachCase(param: SecurityMonitoringApiDetachCaseRequest, options?: Configuration): Promise<void>;
     /**
      * Modify the triage assignee of a security signal.
      * @param param The request object