Regenerate client from commit 0f5bd41 of spec repo (#548)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-03-01 10:11:45.143107",
-            "spec_repo_commit": "7fe3e9a"
+            "regenerated": "2022-03-02 11:11:25.004793",
+            "spec_repo_commit": "0f5bd41"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-03-01 10:11:45.164871",
-            "spec_repo_commit": "7fe3e9a"
+            "regenerated": "2022-03-02 11:11:25.024121",
+            "spec_repo_commit": "0f5bd41"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -5145,11 +5145,13 @@ components:
       - threshold
       - new_value
       - anomaly_detection
+      - impossible_travel
       type: string
       x-enum-varnames:
       - THRESHOLD
       - NEW_VALUE
       - ANOMALY_DETECTION
+      - IMPOSSIBLE_TRAVEL
     SecurityMonitoringRuleEvaluationWindow:
       description: 'A time window is specified to match when at least one of the cases
         matches true. This is a sliding window
@@ -5175,6 +5177,20 @@ components:
       - THIRTY_MINUTES
       - ONE_HOUR
       - TWO_HOURS
+    SecurityMonitoringRuleImpossibleTravelOptions:
+      description: Options on impossible travel rules.
+      properties:
+        baselineUserLocations:
+          $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations'
+      type: object
+    SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations:
+      description: 'If true, signals are suppressed for the first 24 hours. In that
+        time, Datadog learns the user''s regular
+
+        access locations. This can be helpful to reduce noise and infer VPN usage
+        or credentialed API access.'
+      example: true
+      type: boolean
     SecurityMonitoringRuleKeepAlive:
       description: "Once a signal is generated, the signal will remain \u201Copen\u201D
         if a case is matched at least once within\nthis keep alive window."
@@ -5283,6 +5299,8 @@ components:
           $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
         evaluationWindow:
           $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
+        impossibleTravelOptions:
+          $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions'
         keepAlive:
           $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive'
         maxSignalDuration:
@@ -5327,13 +5345,15 @@ components:
       - sum
       - max
       - new_value
+      - geo_data
       type: string
       x-enum-varnames:
       - COUNT
       - CARDINALITY
       - SUM
       - MAX
       - NEW_VALUE
+      - GEO_DATA
     SecurityMonitoringRuleQueryCreate:
       description: Query for matching rule.
       properties:

cassettes/v2/Security-Monitoring_1187227211/Create-a-detection-rule-with-type-impossible_travel-returns-OK-response_4217150877/frozen.json

@@ -0,0 +1 @@
+"2022-02-28T13:21:57.338Z"

cassettes/v2/Security-Monitoring_1187227211/Create-a-detection-rule-with-type-impossible_travel-returns-OK-response_4217150877/recording.har

@@ -0,0 +1,104 @@
+{
+  "log": {
+    "_recordingName": "Security Monitoring/Create a detection rule with type 'impossible_travel' returns \"OK\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.4"
+    },
+    "entries": [
+      {
+        "_id": "49af63a7878d8b792558be5c73238678",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 565,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 587,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"cases\":[{\"name\":\"\",\"notifications\":[],\"status\":\"info\"}],\"filters\":[],\"hasExtendedTitle\":true,\"isEnabled\":true,\"message\":\"test\",\"name\":\"Test-Create_a_detection_rule_with_type_impossible_travel_returns_OK_response-1646054517\",\"options\":{\"detectionMethod\":\"impossible_travel\",\"evaluationWindow\":900,\"impossibleTravelOptions\":{\"baselineUserLocations\":false},\"keepAlive\":3600,\"maxSignalDuration\":86400},\"queries\":[{\"aggregation\":\"geo_data\",\"distinctFields\":[],\"groupByFields\":[\"@usr.id\"],\"metric\":\"@network.client.geoip\",\"query\":\"*\"}],\"tags\":[],\"type\":\"log_detection\"}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v2/security_monitoring/rules"
+        },
+        "response": {
+          "bodySize": 695,
+          "content": {
+            "mimeType": "application/json;charset=utf-8",
+            "size": 695,
+            "text": "{\"creationAuthorId\":1445416,\"tags\":[],\"isEnabled\":true,\"hasExtendedTitle\":true,\"message\":\"test\",\"options\":{\"impossibleTravelOptions\":{\"baselineUserLocations\":false},\"detectionMethod\":\"impossible_travel\",\"evaluationWindow\":900,\"maxSignalDuration\":86400,\"keepAlive\":3600},\"version\":1,\"createdAt\":1646054517609,\"filters\":[],\"queries\":[{\"distinctFields\":[],\"name\":\"\",\"metric\":\"@network.client.geoip\",\"aggregation\":\"geo_data\",\"groupByFields\":[\"@usr.id\"],\"query\":\"*\"}],\"isDeleted\":false,\"cases\":[{\"status\":\"info\",\"notifications\":[],\"name\":\"\"}],\"type\":\"log_detection\",\"id\":\"7xa-vww-kan\",\"isDefault\":false,\"name\":\"Test-Create_a_detection_rule_with_type_impossible_travel_returns_OK_response-1646054517\"}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json;charset=utf-8"
+            }
+          ],
+          "headersSize": 713,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-02-28T13:21:57.366Z",
+        "time": 405
+      },
+      {
+        "_id": "07886f91301edcde50ad9b96dd700e94",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 548,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v2/security_monitoring/rules/7xa-vww-kan"
+        },
+        "response": {
+          "bodySize": 0,
+          "content": {
+            "mimeType": "text/plain",
+            "size": 0
+          },
+          "cookies": [],
+          "headers": [],
+          "headersSize": 646,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 204,
+          "statusText": "No Content"
+        },
+        "startedDateTime": "2022-02-28T13:21:57.820Z",
+        "time": 298
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v2/security-monitoring/CreateSecurityMonitoringRule_461183901.ts

@@ -0,0 +1,54 @@
+/**
+ * Create a detection rule with type 'impossible_travel' returns "OK" response
+ */
+
+import { v2 } from "@datadog/datadog-api-client";
+
+const configuration = v2.createConfiguration();
+const apiInstance = new v2.SecurityMonitoringApi(configuration);
+
+let params: v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest = {
+  body: {
+    queries: [
+      {
+        aggregation: "geo_data",
+        groupByFields: ["@usr.id"],
+        distinctFields: [],
+        metric: "@network.client.geoip",
+        query: "*",
+      },
+    ],
+    cases: [
+      {
+        name: "",
+        status: "info",
+        notifications: [],
+      },
+    ],
+    hasExtendedTitle: true,
+    message: "test",
+    isEnabled: true,
+    options: {
+      maxSignalDuration: 86400,
+      evaluationWindow: 900,
+      keepAlive: 3600,
+      detectionMethod: "impossible_travel",
+      impossibleTravelOptions: {
+        baselineUserLocations: false,
+      },
+    },
+    name: "Example-Create_a_detection_rule_with_type_impossible_travel_returns_OK_response",
+    type: "log_detection",
+    tags: [],
+    filters: [],
+  },
+};
+
+apiInstance
+  .createSecurityMonitoringRule(params)
+  .then((data: v2.SecurityMonitoringRuleResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v2/security_monitoring.feature

@@ -21,6 +21,13 @@ Feature: Security Monitoring
     When the request is sent
     Then the response status is 200 OK
 
+  @team:DataDog/security-monitoring
+  Scenario: Create a detection rule with type 'impossible_travel' returns "OK" response
+    Given new "CreateSecurityMonitoringRule" request
+    And body with value {"queries":[{"aggregation":"geo_data","groupByFields":["@usr.id"],"distinctFields":[],"metric":"@network.client.geoip","query":"*"}],"cases":[{"name":"","status":"info","notifications":[]}],"hasExtendedTitle":true,"message":"test","isEnabled":true,"options":{"maxSignalDuration":86400,"evaluationWindow":900,"keepAlive":3600,"detectionMethod":"impossible_travel","impossibleTravelOptions":{"baselineUserLocations":false}},"name":"{{ unique }}","type":"log_detection","tags":[],"filters":[]}
+    When the request is sent
+    Then the response status is 200 OK
+
   @team:DataDog/security-monitoring
   Scenario: Create a detection rule with type 'workload_security' returns "OK" response
     Given new "CreateSecurityMonitoringRule" request
@@ -207,22 +214,22 @@ Feature: Security Monitoring
   Scenario: Update an existing rule returns "Bad Request" response
     Given new "UpdateSecurityMonitoringRule" request
     And request contains "rule_id" parameter from "REPLACE.ME"
-    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
+    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "impossibleTravelOptions": {"baselineUserLocations": true}, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/security-monitoring
   Scenario: Update an existing rule returns "Not Found" response
     Given new "UpdateSecurityMonitoringRule" request
     And request contains "rule_id" parameter from "REPLACE.ME"
-    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
+    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "impossibleTravelOptions": {"baselineUserLocations": true}, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
     When the request is sent
     Then the response status is 404 Not Found
 
   @generated @skip @team:DataDog/security-monitoring
   Scenario: Update an existing rule returns "OK" response
     Given new "UpdateSecurityMonitoringRule" request
     And request contains "rule_id" parameter from "REPLACE.ME"
-    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
+    And body with value {"cases": [{"condition": null, "name": null, "notifications": [null], "status": "critical"}], "filters": [{"action": "require", "query": null}], "hasExtendedTitle": true, "isEnabled": null, "message": null, "name": null, "options": {"detectionMethod": "threshold", "evaluationWindow": 0, "impossibleTravelOptions": {"baselineUserLocations": true}, "keepAlive": 0, "maxSignalDuration": 0, "newValueOptions": {"forgetAfter": 1, "learningDuration": 0}}, "queries": [{"aggregation": "count", "distinctFields": [null], "groupByFields": [null], "metric": null, "name": null, "query": null}], "tags": [null], "version": 1}
     When the request is sent
     Then the response status is 200 OK

packages/datadog-api-client-v2/.openapi-generator/FILES

@@ -370,6 +370,7 @@ models/SecurityMonitoringRuleCaseCreate.ts
 models/SecurityMonitoringRuleCreatePayload.ts
 models/SecurityMonitoringRuleDetectionMethod.ts
 models/SecurityMonitoringRuleEvaluationWindow.ts
+models/SecurityMonitoringRuleImpossibleTravelOptions.ts
 models/SecurityMonitoringRuleKeepAlive.ts
 models/SecurityMonitoringRuleMaxSignalDuration.ts
 models/SecurityMonitoringRuleNewValueOptions.ts

packages/datadog-api-client-v2/index.ts

@@ -507,6 +507,7 @@ export { SecurityMonitoringRuleCaseCreate } from "./models/SecurityMonitoringRul
 export { SecurityMonitoringRuleCreatePayload } from "./models/SecurityMonitoringRuleCreatePayload";
 export { SecurityMonitoringRuleDetectionMethod } from "./models/SecurityMonitoringRuleDetectionMethod";
 export { SecurityMonitoringRuleEvaluationWindow } from "./models/SecurityMonitoringRuleEvaluationWindow";
+export { SecurityMonitoringRuleImpossibleTravelOptions } from "./models/SecurityMonitoringRuleImpossibleTravelOptions";
 export { SecurityMonitoringRuleKeepAlive } from "./models/SecurityMonitoringRuleKeepAlive";
 export { SecurityMonitoringRuleMaxSignalDuration } from "./models/SecurityMonitoringRuleMaxSignalDuration";
 export { SecurityMonitoringRuleNewValueOptions } from "./models/SecurityMonitoringRuleNewValueOptions";

packages/datadog-api-client-v2/models/ObjectSerializer.ts

@@ -260,6 +260,7 @@ import { SecurityMonitoringListRulesResponse } from "./SecurityMonitoringListRul
 import { SecurityMonitoringRuleCase } from "./SecurityMonitoringRuleCase";
 import { SecurityMonitoringRuleCaseCreate } from "./SecurityMonitoringRuleCaseCreate";
 import { SecurityMonitoringRuleCreatePayload } from "./SecurityMonitoringRuleCreatePayload";
+import { SecurityMonitoringRuleImpossibleTravelOptions } from "./SecurityMonitoringRuleImpossibleTravelOptions";
 import { SecurityMonitoringRuleNewValueOptions } from "./SecurityMonitoringRuleNewValueOptions";
 import { SecurityMonitoringRuleOptions } from "./SecurityMonitoringRuleOptions";
 import { SecurityMonitoringRuleQuery } from "./SecurityMonitoringRuleQuery";
@@ -433,6 +434,7 @@ const enumsMap: { [key: string]: any[] } = {
     "threshold",
     "new_value",
     "anomaly_detection",
+    "impossible_travel",
   ],
   SecurityMonitoringRuleEvaluationWindow: [
     0, 60, 300, 600, 900, 1800, 3600, 7200,
@@ -451,6 +453,7 @@ const enumsMap: { [key: string]: any[] } = {
     "sum",
     "max",
     "new_value",
+    "geo_data",
   ],
   SecurityMonitoringRuleSeverity: ["info", "low", "medium", "high", "critical"],
   SecurityMonitoringRuleTypeCreate: ["log_detection", "workload_security"],
@@ -749,6 +752,8 @@ const typeMap: { [index: string]: any } = {
   SecurityMonitoringRuleCase: SecurityMonitoringRuleCase,
   SecurityMonitoringRuleCaseCreate: SecurityMonitoringRuleCaseCreate,
   SecurityMonitoringRuleCreatePayload: SecurityMonitoringRuleCreatePayload,
+  SecurityMonitoringRuleImpossibleTravelOptions:
+    SecurityMonitoringRuleImpossibleTravelOptions,
   SecurityMonitoringRuleNewValueOptions: SecurityMonitoringRuleNewValueOptions,
   SecurityMonitoringRuleOptions: SecurityMonitoringRuleOptions,
   SecurityMonitoringRuleQuery: SecurityMonitoringRuleQuery,

packages/datadog-api-client-v2/models/SecurityMonitoringRuleDetectionMethod.ts

@@ -11,7 +11,9 @@
 export type SecurityMonitoringRuleDetectionMethod =
   | typeof THRESHOLD
   | typeof NEW_VALUE
-  | typeof ANOMALY_DETECTION;
+  | typeof ANOMALY_DETECTION
+  | typeof IMPOSSIBLE_TRAVEL;
 export const THRESHOLD = "threshold";
 export const NEW_VALUE = "new_value";
 export const ANOMALY_DETECTION = "anomaly_detection";
+export const IMPOSSIBLE_TRAVEL = "impossible_travel";