datadog_api_client 2.31.1 → 2.33.0

data/examples/v2/on-call/CreateOnCallEscalationPolicy.rb

@@ -0,0 +1,66 @@
+# Create on-call escalation policy returns "Created" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "user" in the system
+USER_DATA_ID = ENV["USER_DATA_ID"]
+
+# there is a valid "schedule" in the system
+SCHEDULE_DATA_ID = ENV["SCHEDULE_DATA_ID"]
+
+# there is a valid "dd_team" in the system
+DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
+
+body = DatadogAPIClient::V2::EscalationPolicyCreateRequest.new({
+  data: DatadogAPIClient::V2::EscalationPolicyCreateRequestData.new({
+    attributes: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributes.new({
+      description: "Escalation Policy 1 description",
+      name: "Example-On-Call",
+      resolve_page_on_policy_end: true,
+      retries: 2,
+      steps: [
+        DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItems.new({
+          assignment: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsAssignment::DEFAULT,
+          escalate_after_seconds: 3600,
+          targets: [
+            DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItems.new({
+              id: USER_DATA_ID,
+              type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType::USERS,
+            }),
+            DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItems.new({
+              id: SCHEDULE_DATA_ID,
+              type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType::SCHEDULES,
+            }),
+            DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItems.new({
+              id: DD_TEAM_DATA_ID,
+              type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType::TEAMS,
+            }),
+          ],
+        }),
+        DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItems.new({
+          assignment: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsAssignment::ROUND_ROBIN,
+          escalate_after_seconds: 3600,
+          targets: [
+            DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItems.new({
+              id: DD_TEAM_DATA_ID,
+              type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataAttributesStepsItemsTargetsItemsType::TEAMS,
+            }),
+          ],
+        }),
+      ],
+    }),
+    relationships: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataRelationships.new({
+      teams: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataRelationshipsTeams.new({
+        data: [
+          DatadogAPIClient::V2::EscalationPolicyCreateRequestDataRelationshipsTeamsDataItems.new({
+            id: DD_TEAM_DATA_ID,
+            type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataRelationshipsTeamsDataItemsType::TEAMS,
+          }),
+        ],
+      }),
+    }),
+    type: DatadogAPIClient::V2::EscalationPolicyCreateRequestDataType::POLICIES,
+  }),
+})
+p api_instance.create_on_call_escalation_policy(body)

data/examples/v2/on-call/CreateOnCallSchedule.rb

@@ -0,0 +1,61 @@
+# Create on-call schedule returns "Created" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "user" in the system
+USER_DATA_ID = ENV["USER_DATA_ID"]
+
+# there is a valid "dd_team" in the system
+DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
+
+body = DatadogAPIClient::V2::ScheduleCreateRequest.new({
+  data: DatadogAPIClient::V2::ScheduleCreateRequestData.new({
+    attributes: DatadogAPIClient::V2::ScheduleCreateRequestDataAttributes.new({
+      layers: [
+        DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItems.new({
+          effective_date: (Time.now + -10 * 86400),
+          end_date: (Time.now + 10 * 86400),
+          interval: DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsInterval.new({
+            days: 1,
+          }),
+          members: [
+            DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsMembersItems.new({
+              user: DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser.new({
+                id: USER_DATA_ID,
+              }),
+            }),
+          ],
+          name: "Layer 1",
+          restrictions: [
+            DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems.new({
+              end_day: DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay::FRIDAY,
+              end_time: "17:00:00",
+              start_day: DatadogAPIClient::V2::ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay::MONDAY,
+              start_time: "09:00:00",
+            }),
+          ],
+          rotation_start: (Time.now + -5 * 86400),
+        }),
+      ],
+      name: "Example-On-Call",
+      tags: [
+        "tag1",
+        "tag2",
+      ],
+      time_zone: "America/New_York",
+    }),
+    relationships: DatadogAPIClient::V2::ScheduleCreateRequestDataRelationships.new({
+      teams: DatadogAPIClient::V2::ScheduleCreateRequestDataRelationshipsTeams.new({
+        data: [
+          DatadogAPIClient::V2::ScheduleCreateRequestDataRelationshipsTeamsDataItems.new({
+            id: DD_TEAM_DATA_ID,
+            type: DatadogAPIClient::V2::ScheduleCreateRequestDataRelationshipsTeamsDataItemsType::TEAMS,
+          }),
+        ],
+      }),
+    }),
+    type: DatadogAPIClient::V2::ScheduleCreateRequestDataType::SCHEDULES,
+  }),
+})
+p api_instance.create_on_call_schedule(body)

data/examples/v2/on-call/DeleteOnCallEscalationPolicy.rb

@@ -0,0 +1,8 @@
+# Delete on-call escalation policy returns "No Content" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "escalation_policy" in the system
+ESCALATION_POLICY_DATA_ID = ENV["ESCALATION_POLICY_DATA_ID"]
+api_instance.delete_on_call_escalation_policy(ESCALATION_POLICY_DATA_ID)

data/examples/v2/on-call/DeleteOnCallSchedule.rb

@@ -0,0 +1,8 @@
+# Delete on-call schedule returns "No Content" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "schedule" in the system
+SCHEDULE_DATA_ID = ENV["SCHEDULE_DATA_ID"]
+api_instance.delete_on_call_schedule(SCHEDULE_DATA_ID)

data/examples/v2/on-call/GetOnCallEscalationPolicy.rb

@@ -0,0 +1,8 @@
+# Get on-call escalation policy returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "escalation_policy" in the system
+ESCALATION_POLICY_DATA_ID = ENV["ESCALATION_POLICY_DATA_ID"]
+p api_instance.get_on_call_escalation_policy(ESCALATION_POLICY_DATA_ID)

data/examples/v2/on-call/GetOnCallSchedule.rb

@@ -0,0 +1,8 @@
+# Get on-call schedule returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "schedule" in the system
+SCHEDULE_DATA_ID = ENV["SCHEDULE_DATA_ID"]
+p api_instance.get_on_call_schedule(SCHEDULE_DATA_ID)

data/examples/v2/on-call/UpdateOnCallEscalationPolicy.rb

@@ -0,0 +1,51 @@
+# Update on-call escalation policy returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "escalation_policy" in the system
+ESCALATION_POLICY_DATA_ID = ENV["ESCALATION_POLICY_DATA_ID"]
+ESCALATION_POLICY_DATA_RELATIONSHIPS_STEPS_DATA_0_ID = ENV["ESCALATION_POLICY_DATA_RELATIONSHIPS_STEPS_DATA_0_ID"]
+
+# there is a valid "user" in the system
+USER_DATA_ID = ENV["USER_DATA_ID"]
+
+# there is a valid "dd_team" in the system
+DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
+
+body = DatadogAPIClient::V2::EscalationPolicyUpdateRequest.new({
+  data: DatadogAPIClient::V2::EscalationPolicyUpdateRequestData.new({
+    attributes: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataAttributes.new({
+      description: "Example-On-Call",
+      name: "Example-On-Call-updated",
+      resolve_page_on_policy_end: false,
+      retries: 0,
+      steps: [
+        DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataAttributesStepsItems.new({
+          assignment: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataAttributesStepsItemsAssignment::DEFAULT,
+          escalate_after_seconds: 3600,
+          id: ESCALATION_POLICY_DATA_RELATIONSHIPS_STEPS_DATA_0_ID,
+          targets: [
+            DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataAttributesStepsItemsTargetsItems.new({
+              id: USER_DATA_ID,
+              type: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataAttributesStepsItemsTargetsItemsType::USERS,
+            }),
+          ],
+        }),
+      ],
+    }),
+    id: ESCALATION_POLICY_DATA_ID,
+    relationships: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataRelationships.new({
+      teams: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataRelationshipsTeams.new({
+        data: [
+          DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataRelationshipsTeamsDataItems.new({
+            id: DD_TEAM_DATA_ID,
+            type: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataRelationshipsTeamsDataItemsType::TEAMS,
+          }),
+        ],
+      }),
+    }),
+    type: DatadogAPIClient::V2::EscalationPolicyUpdateRequestDataType::POLICIES,
+  }),
+})
+p api_instance.update_on_call_escalation_policy(ESCALATION_POLICY_DATA_ID, body)

data/examples/v2/on-call/UpdateOnCallSchedule.rb

@@ -0,0 +1,68 @@
+# Update on-call schedule returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::On - CallAPI.new
+
+# there is a valid "schedule" in the system
+SCHEDULE_DATA_ID = ENV["SCHEDULE_DATA_ID"]
+SCHEDULE_DATA_RELATIONSHIPS_LAYERS_DATA_0_ID = ENV["SCHEDULE_DATA_RELATIONSHIPS_LAYERS_DATA_0_ID"]
+
+# there is a valid "user" in the system
+USER_DATA_ID = ENV["USER_DATA_ID"]
+
+# there is a valid "dd_team" in the system
+DD_TEAM_DATA_ID = ENV["DD_TEAM_DATA_ID"]
+
+body = DatadogAPIClient::V2::ScheduleUpdateRequest.new({
+  data: DatadogAPIClient::V2::ScheduleUpdateRequestData.new({
+    id: SCHEDULE_DATA_ID,
+    attributes: DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributes.new({
+      layers: [
+        DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItems.new({
+          id: SCHEDULE_DATA_RELATIONSHIPS_LAYERS_DATA_0_ID,
+          effective_date: (Time.now + -10 * 86400),
+          end_date: (Time.now + 10 * 86400),
+          interval: DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsInterval.new({
+            seconds: 300,
+          }),
+          members: [
+            DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsMembersItems.new({
+              user: DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser.new({
+                id: USER_DATA_ID,
+              }),
+            }),
+          ],
+          name: "Layer 1",
+          restrictions: [
+            DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems.new({
+              end_day: DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay::FRIDAY,
+              end_time: "17:00:00",
+              start_day: DatadogAPIClient::V2::ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay::MONDAY,
+              start_time: "09:00:00",
+            }),
+          ],
+          rotation_start: (Time.now + -5 * 86400),
+        }),
+      ],
+      name: "Example-On-Call",
+      tags: [
+        "tag1",
+        "tag2",
+        "tag3",
+      ],
+      time_zone: "America/New_York",
+    }),
+    relationships: DatadogAPIClient::V2::ScheduleUpdateRequestDataRelationships.new({
+      teams: DatadogAPIClient::V2::ScheduleUpdateRequestDataRelationshipsTeams.new({
+        data: [
+          DatadogAPIClient::V2::ScheduleUpdateRequestDataRelationshipsTeamsDataItems.new({
+            id: DD_TEAM_DATA_ID,
+            type: DatadogAPIClient::V2::ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType::TEAMS,
+          }),
+        ],
+      }),
+    }),
+    type: DatadogAPIClient::V2::ScheduleUpdateRequestDataType::SCHEDULES,
+  }),
+})
+p api_instance.update_on_call_schedule(SCHEDULE_DATA_ID, body)

data/examples/v2/security-monitoring/CreateCustomFramework.rb

@@ -0,0 +1,30 @@
+# Create a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::CreateCustomFrameworkRequest.new({
+  data: DatadogAPIClient::V2::CustomFrameworkData.new({
+    type: DatadogAPIClient::V2::CustomFrameworkType::CUSTOM_FRAMEWORK,
+    attributes: DatadogAPIClient::V2::CustomFrameworkDataAttributes.new({
+      name: "name",
+      handle: "create-framework-new",
+      version: "10",
+      icon_url: "test-url",
+      requirements: [
+        DatadogAPIClient::V2::CustomFrameworkRequirement.new({
+          name: "requirement",
+          controls: [
+            DatadogAPIClient::V2::CustomFrameworkControl.new({
+              name: "control",
+              rules_id: [
+                "def-000-be9",
+              ],
+            }),
+          ],
+        }),
+      ],
+    }),
+  }),
+})
+p api_instance.create_custom_framework(body)

data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1965169892.rb

@@ -31,6 +31,12 @@ body = DatadogAPIClient::V2::SecurityMonitoringStandardRuleCreatePayload.new({
             duration: 900,
           }),
         }),
+        DatadogAPIClient::V2::SecurityMonitoringRuleCaseAction.new({
+          type: DatadogAPIClient::V2::SecurityMonitoringRuleCaseActionType::USER_BEHAVIOR,
+          options: DatadogAPIClient::V2::SecurityMonitoringRuleCaseActionOptions.new({
+            user_behavior_name: "behavior",
+          }),
+        }),
       ],
     }),
   ],

data/examples/v2/security-monitoring/DeleteCustomFramework.rb

@@ -0,0 +1,5 @@
+# Delete a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.delete_custom_framework("create-framework-new", "10")

data/examples/v2/security-monitoring/GetCustomFramework.rb

@@ -0,0 +1,5 @@
+# Get a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.get_custom_framework("create-framework-new", "10")

data/examples/v2/security-monitoring/UpdateCustomFramework.rb

@@ -0,0 +1,30 @@
+# Update a custom framework returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+body = DatadogAPIClient::V2::UpdateCustomFrameworkRequest.new({
+  data: DatadogAPIClient::V2::CustomFrameworkData.new({
+    type: DatadogAPIClient::V2::CustomFrameworkType::CUSTOM_FRAMEWORK,
+    attributes: DatadogAPIClient::V2::CustomFrameworkDataAttributes.new({
+      name: "name",
+      handle: "create-framework-new",
+      version: "10",
+      icon_url: "test-url",
+      requirements: [
+        DatadogAPIClient::V2::CustomFrameworkRequirement.new({
+          name: "requirement",
+          controls: [
+            DatadogAPIClient::V2::CustomFrameworkControl.new({
+              name: "control",
+              rules_id: [
+                "def-000-be9",
+              ],
+            }),
+          ],
+        }),
+      ],
+    }),
+  }),
+})
+p api_instance.update_custom_framework("create-framework-new", "10", body)

data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb

@@ -56,6 +56,6 @@ body = DatadogAPIClient::V2::ServiceDefinitionV2Dot2.new({
   ],
   team: "my-team",
   tier: "High",
-  type: DatadogAPIClient::V2::ServiceDefinitionV2Dot2Type::WEB,
+  type: "web",
 })
 p api_instance.create_or_update_service_definitions(body)

data/examples/v2/software-catalog/UpsertCatalogEntity.rb

@@ -62,6 +62,7 @@ body = DatadogAPIClient::V2::EntityV3Service.new({
     ],
   }),
   spec: DatadogAPIClient::V2::EntityV3ServiceSpec.new({
+    component_of: [],
     depends_on: [],
     languages: [],
   }),

data/lib/datadog_api_client/configuration.rb

@@ -194,6 +194,19 @@ module DatadogAPIClient
             "v2.get_open_api": false,
             "v2.list_apis": false,
             "v2.update_open_api": false,
+            "v2.cancel_historical_job": false,
+            "v2.convert_job_result_to_signal": false,
+            "v2.delete_historical_job": false,
+            "v2.get_finding": false,
+            "v2.get_historical_job": false,
+            "v2.get_rule_version_history": false,
+            "v2.get_sbom": false,
+            "v2.list_findings": false,
+            "v2.list_historical_jobs": false,
+            "v2.list_vulnerabilities": false,
+            "v2.list_vulnerable_assets": false,
+            "v2.mute_findings": false,
+            "v2.run_historical_job": false,
             "v2.cancel_data_deletion_request": false,
             "v2.create_data_deletion_request": false,
             "v2.get_data_deletion_requests": false,
@@ -230,19 +243,18 @@ module DatadogAPIClient
             "v2.list_aws_namespaces": false,
             "v2.update_aws_account": false,
             "v2.list_aws_logs_services": false,
-            "v2.cancel_historical_job": false,
-            "v2.convert_job_result_to_signal": false,
-            "v2.delete_historical_job": false,
-            "v2.get_finding": false,
-            "v2.get_historical_job": false,
-            "v2.get_rule_version_history": false,
-            "v2.get_sbom": false,
-            "v2.list_findings": false,
-            "v2.list_historical_jobs": false,
-            "v2.list_vulnerabilities": false,
-            "v2.list_vulnerable_assets": false,
-            "v2.mute_findings": false,
-            "v2.run_historical_job": false,
+            "v2.create_monitor_notification_rule": false,
+            "v2.delete_monitor_notification_rule": false,
+            "v2.get_monitor_notification_rule": false,
+            "v2.get_monitor_notification_rules": false,
+            "v2.update_monitor_notification_rule": false,
+            "v2.get_aggregated_connections": false,
+            "v2.create_pipeline": false,
+            "v2.delete_pipeline": false,
+            "v2.get_pipeline": false,
+            "v2.list_pipelines": false,
+            "v2.update_pipeline": false,
+            "v2.validate_pipeline": false,
             "v2.create_scorecard_outcomes_batch": false,
             "v2.create_scorecard_rule": false,
             "v2.delete_scorecard_rule": false,