datadog_api_client 2.17.0 → 2.18.0

data/.generator/src/generator/cli.py

@@ -55,6 +55,7 @@ def cli(specs, output):
     api_j2 = env.get_template("api.j2")
     model_j2 = env.get_template("model.j2")
     package_j2 = env.get_template("package.j2")
+    datadog_api_client_j2 = env.get_template("datadog_api_client.j2")
 
     extra_files = {
         "model_base.rb": env.get_template("model_base.j2"),
@@ -120,6 +121,10 @@ def cli(specs, output):
         with filename.open("w") as fp:
             fp.write(template.render(all_apis=all_apis, all_specs=all_specs, all_models=all_models))
 
+    datadog_api_client_output = output / "datadog_api_client.rb"
+    with datadog_api_client_output.open("w") as fp:
+        fp.write(datadog_api_client_j2.render(all_apis=all_apis))
+
     # Parameter mappings for bdd tests
     scenarios_test_output = pathlib.Path("../features/")
     for name, template in test_scenarios_files.items():

data/.generator/src/generator/templates/datadog_api_client.j2

@@ -0,0 +1,19 @@
+=begin
+{% include "api_info.j2" %}
+=end
+
+require 'datadog_api_client/models'
+require_relative 'datadog_api_client/inflector'
+
+loader = Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, ".rb")
+loader.collapse("#{__dir__}/datadog_api_client/*/models/")
+loader.collapse("#{__dir__}/datadog_api_client/*/api/")
+
+{%- for version, apis in all_apis.items() %}
+loader.push_dir("#{__dir__}/datadog_api_client/{{ version }}", namespace: DatadogAPIClient::{{ version|upper }})
+{%- endfor %}
+# Ignore model_base.rb from being loaded in by zeitwerk as it is loaded in by default
+loader.ignore("#{__dir__}/datadog_api_client/*/model_base.rb")
+loader.inflector = {{ module_name }}::{{ module_name }}Inflector.new
+loader.setup

data/.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
     name: Generate
     language: system
     entry: bash -c "./generate.sh"
-    files: '^(\.generator/.*|\.pre-commit-config\.yaml|Makefile|\features/.*)'
+    files: '^(\.generator/.*|\.pre-commit-config\.yaml|Makefile|\features/.*|lib/.*)'
     pass_filenames: false
   - id: format-examples
     name: Format generated examples

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # CHANGELOG
 
+## 2.18.0 / 2023-12-12
+
+### Fixed
+* Fix Powerpack schema by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1613
+### Added
+* Add support for projected-cost endpoint by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1598
+* Document missing incident fields by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1617
+* Add active billing dimensions to usage metering by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1637
+* Add Cost Attribution To Usage Metering Public Beta Documentation by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1622
+* Update spec to include new DORA API endpoints by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1636
+* Add support to patch Synthetics test with partial data using JSON Patch by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1630
+* Document new api/app key schemas by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1616
+* Document new field `filters` for `CloudWorkloadSecurityAgentRule` by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1638
+* Live and historical custom timeseries docs by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1628
+* Add week_to_date and month_to_date to widget livespan by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1631
+* Document `included_keywords` in `ListStandardPatterns` response by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1641
+* Document fields `remote_config_read_enabled` and `category` by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1639
+* Update Azure Spec to include Resource Collection by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1646
+* Allow creation of Application Security detection rules from the v2 API by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1648
+* Add Okta Integration APIs by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1629
+* Remove unstable flag for Events v2 api by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1653
+
+
+**Full Changelog**: https://github.com/DataDog/datadog-api-client-ruby/compare/v2.17.0...v2.18.0
+
 ## 2.17.0 / 2023-11-15
 
 ### Fixed

data/examples/v1/aws-integration/CreateAWSAccount.rb

@@ -4,9 +4,9 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AWSAccount.new({
-  account_id: "123456789012",
+  account_id: "163662907100",
   account_specific_namespace_rules: {
-    auto_scaling: false, opswork: false,
+    auto_scaling: false,
   },
   cspm_resource_collection_enabled: true,
   excluded_regions: [

data/examples/v1/aws-integration/DeleteAWSAccount.rb

@@ -4,7 +4,7 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AWSAccountDeleteRequest.new({
-  account_id: "123456789012",
+  account_id: "163662907100",
   role_name: "DatadogAWSIntegrationRole",
 })
 p api_instance.delete_aws_account(body)

data/examples/v1/aws-integration/UpdateAWSAccount.rb

@@ -4,11 +4,11 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AWSAccount.new({
-  account_id: "123456789012",
+  account_id: "163662907100",
   account_specific_namespace_rules: {
     auto_scaling: false,
   },
-  cspm_resource_collection_enabled: true,
+  cspm_resource_collection_enabled: false,
   excluded_regions: [
     "us-east-1",
     "us-west-2",
@@ -19,12 +19,12 @@ body = DatadogAPIClient::V1::AWSAccount.new({
   host_tags: [
     "$KEY:$VALUE",
   ],
-  metrics_collection_enabled: false,
+  metrics_collection_enabled: true,
   resource_collection_enabled: true,
-  role_name: "datadog-role",
+  role_name: "DatadogAWSIntegrationRole",
 })
 opts = {
-  account_id: "123456789012",
-  role_name: "datadog-role",
+  account_id: "163662907100",
+  role_name: "DatadogAWSIntegrationRole",
 }
 p api_instance.update_aws_account(body, opts)

data/examples/v1/azure-integration/CreateAzureIntegration.rb

@@ -17,6 +17,7 @@ body = DatadogAPIClient::V1::AzureAccount.new({
   host_filters: "key:value,filter:example",
   new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test",
   new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest",
+  resource_collection_enabled: true,
   tenant_name: "testc44-1234-5678-9101-cc00736ftest",
 })
 p api_instance.create_azure_integration(body)

data/examples/v1/azure-integration/DeleteAzureIntegration.rb

@@ -17,6 +17,7 @@ body = DatadogAPIClient::V1::AzureAccount.new({
   host_filters: "key:value,filter:example",
   new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test",
   new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest",
+  resource_collection_enabled: true,
   tenant_name: "testc44-1234-5678-9101-cc00736ftest",
 })
 p api_instance.delete_azure_integration(body)

data/examples/v1/azure-integration/UpdateAzureHostFilters.rb

@@ -17,6 +17,7 @@ body = DatadogAPIClient::V1::AzureAccount.new({
   host_filters: "key:value,filter:example",
   new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test",
   new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest",
+  resource_collection_enabled: true,
   tenant_name: "testc44-1234-5678-9101-cc00736ftest",
 })
 p api_instance.update_azure_host_filters(body)

data/examples/v1/azure-integration/UpdateAzureIntegration.rb

@@ -17,6 +17,7 @@ body = DatadogAPIClient::V1::AzureAccount.new({
   host_filters: "key:value,filter:example",
   new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test",
   new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest",
+  resource_collection_enabled: true,
   tenant_name: "testc44-1234-5678-9101-cc00736ftest",
 })
 p api_instance.update_azure_integration(body)

data/examples/v1/dashboards/CreateDashboard_1284514532.rb

@@ -35,6 +35,9 @@ body = DatadogAPIClient::V1::Dashboard.new({
             display_type: DatadogAPIClient::V1::WidgetDisplayType::BARS,
           }),
         ],
+        time: DatadogAPIClient::V1::WidgetTime.new({
+          live_span: DatadogAPIClient::V1::WidgetLiveSpan::WEEK_TO_DATE,
+        }),
       }),
     }),
   ],

data/examples/v1/synthetics/PatchTest.rb

@@ -0,0 +1,22 @@
+# Patch a Synthetic test returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
+
+# there is a valid "synthetics_api_test" in the system
+SYNTHETICS_API_TEST_PUBLIC_ID = ENV["SYNTHETICS_API_TEST_PUBLIC_ID"]
+
+body = DatadogAPIClient::V1::SyntheticsPatchTestBody.new({
+  data: [
+    DatadogAPIClient::V1::SyntheticsPatchTestOperation.new({
+      op: DatadogAPIClient::V1::SyntheticsPatchTestOperationName::REPLACE,
+      path: "/name",
+      value: "New test name",
+    }),
+    DatadogAPIClient::V1::SyntheticsPatchTestOperation.new({
+      op: DatadogAPIClient::V1::SyntheticsPatchTestOperationName::REMOVE,
+      path: "/config/assertions/0",
+    }),
+  ],
+})
+p api_instance.patch_test(SYNTHETICS_API_TEST_PUBLIC_ID, body)

data/examples/v2/container-images/ListContainerImages.rb

@@ -1,8 +1,5 @@
 # Get all Container Images returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_container_images".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainerImagesAPI.new
 p api_instance.list_container_images()

data/examples/v2/container-images/ListContainerImages_3088586393.rb

@@ -1,9 +1,6 @@
 # Get all Container Images returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_container_images".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainerImagesAPI.new
 opts = {
   page_size: 2,

data/examples/v2/container-images/ListContainerImages_3974828736.rb

@@ -1,9 +1,6 @@
 # Get all Container Image groups returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_container_images".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainerImagesAPI.new
 opts = {
   group_by: "short_image",

data/examples/v2/containers/ListContainers.rb

@@ -1,8 +1,5 @@
 # Get All Containers returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_containers".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainersAPI.new
 p api_instance.list_containers()

data/examples/v2/containers/ListContainers_2175733917.rb

@@ -1,9 +1,6 @@
 # Get All Container groups returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_containers".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainersAPI.new
 opts = {
   group_by: "short_image",

data/examples/v2/containers/ListContainers_931009654.rb

@@ -1,9 +1,6 @@
 # Get All Containers returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_containers".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::ContainersAPI.new
 opts = {
   page_size: 2,

data/examples/v2/dora-metrics/CreateDORADeployment.rb

@@ -0,0 +1,23 @@
+# Send a deployment event for DORA Metrics returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_dora_deployment".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new
+
+body = DatadogAPIClient::V2::DORADeploymentRequest.new({
+  data: DatadogAPIClient::V2::DORADeploymentRequestData.new({
+    attributes: DatadogAPIClient::V2::DORADeploymentRequestAttributes.new({
+      finished_at: 1693491984000000000,
+      git: DatadogAPIClient::V2::DORAGitInfo.new({
+        commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588",
+        repository_url: "https://github.com/organization/example-repository",
+      }),
+      service: "shopist",
+      started_at: 1693491974000000000,
+      version: "v1.12.07",
+    }),
+  }),
+})
+p api_instance.create_dora_deployment(body)

data/examples/v2/dora-metrics/CreateDORAIncident.rb

@@ -0,0 +1,25 @@
+# Send an incident event for DORA Metrics returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_dora_incident".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::DORAMetricsAPI.new
+
+body = DatadogAPIClient::V2::DORAIncidentRequest.new({
+  data: DatadogAPIClient::V2::DORAIncidentRequestData.new({
+    attributes: DatadogAPIClient::V2::DORAIncidentRequestAttributes.new({
+      finished_at: 1693491984000000000,
+      git: DatadogAPIClient::V2::DORAGitInfo.new({
+        commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588",
+        repository_url: "https://github.com/organization/example-repository",
+      }),
+      name: "Webserver is down failing all requests",
+      service: "shopist",
+      severity: "High",
+      started_at: 1693491974000000000,
+      version: "v1.12.07",
+    }),
+  }),
+})
+p api_instance.create_dora_incident(body)

data/examples/v2/events/ListEvents.rb

@@ -1,8 +1,5 @@
 # Get a list of events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 p api_instance.list_events()

data/examples/v2/events/ListEvents_1527584014.rb

@@ -1,9 +1,6 @@
 # Get a list of events returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 opts = {
   filter_from: "now-15m",

data/examples/v2/events/ListEvents_2663715109.rb

@@ -1,9 +1,6 @@
 # Get a quick list of events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 opts = {
   filter_query: "datadog-agent",

data/examples/v2/events/SearchEvents.rb

@@ -1,9 +1,6 @@
 # Search events returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.search_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 
 body = DatadogAPIClient::V2::EventsListRequest.new({

data/examples/v2/events/SearchEvents_3856995058.rb

@@ -1,9 +1,6 @@
 # Search events returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.search_events".to_sym] = true
-end
 api_instance = DatadogAPIClient::V2::EventsAPI.new
 
 body = DatadogAPIClient::V2::EventsListRequest.new({

data/examples/v2/okta-integration/CreateOktaAccount.rb

@@ -0,0 +1,19 @@
+# Add Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+body = DatadogAPIClient::V2::OktaAccountRequest.new({
+  data: DatadogAPIClient::V2::OktaAccount.new({
+    attributes: DatadogAPIClient::V2::OktaAccountAttributes.new({
+      auth_method: "oauth",
+      domain: "https://example.okta.com/",
+      name: "Okta_Prod",
+      client_id: "client_id",
+      client_secret: "client_secret",
+    }),
+    id: "f749daaf-682e-4208-a38d-c9b43162c609",
+    type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
+  }),
+})
+p api_instance.create_okta_account(body)

data/examples/v2/okta-integration/DeleteOktaAccount.rb

@@ -0,0 +1,5 @@
+# Delete Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+api_instance.delete_okta_account("account_id")

data/examples/v2/okta-integration/GetOktaAccount.rb

@@ -0,0 +1,8 @@
+# Get Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+# there is a valid "okta_account" in the system
+OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
+p api_instance.get_okta_account(OKTA_ACCOUNT_DATA_ID)

data/examples/v2/okta-integration/ListOktaAccounts.rb

@@ -0,0 +1,5 @@
+# List Okta accounts returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+p api_instance.list_okta_accounts()

data/examples/v2/okta-integration/UpdateOktaAccount.rb

@@ -0,0 +1,20 @@
+# Update Okta account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
+
+# there is a valid "okta_account" in the system
+OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
+
+body = DatadogAPIClient::V2::OktaAccountUpdateRequest.new({
+  data: DatadogAPIClient::V2::OktaAccountUpdateRequestData.new({
+    attributes: DatadogAPIClient::V2::OktaAccountUpdateRequestAttributes.new({
+      auth_method: "oauth",
+      domain: "https://example.okta.com/",
+      client_id: "client_id",
+      client_secret: "client_secret",
+    }),
+    type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
+  }),
+})
+p api_instance.update_okta_account(OKTA_ACCOUNT_DATA_ID, body)

data/examples/v2/usage-metering/GetActiveBillingDimensions.rb

@@ -0,0 +1,8 @@
+# Get active billing dimensions for cost attribution returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_active_billing_dimensions".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+p api_instance.get_active_billing_dimensions()

data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb

@@ -0,0 +1,8 @@
+# Get Monthly Cost Attribution returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_monthly_cost_attribution".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+p api_instance.get_monthly_cost_attribution((Time.now + -5 * 86400), (Time.now + -3 * 86400), "infra_host_total_cost")

data/examples/v2/usage-metering/GetProjectedCost.rb

@@ -0,0 +1,8 @@
+# Get projected cost across your account returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::UsageMeteringAPI.new
+opts = {
+  view: "sub-org",
+}
+p api_instance.get_projected_cost(opts)

data/lib/datadog_api_client/configuration.rb

@@ -190,10 +190,10 @@ module DatadogAPIClient
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
       @unstable_operations = {
             "v2.create_ci_app_pipeline_event": false,
-            "v2.list_container_images": false,
-            "v2.list_containers": false,
-            "v2.list_events": false,
-            "v2.search_events": false,
+            "v2.get_active_billing_dimensions": false,
+            "v2.get_monthly_cost_attribution": false,
+            "v2.create_dora_deployment": false,
+            "v2.create_dora_incident": false,
             "v2.create_incident": false,
             "v2.create_incident_integration": false,
             "v2.create_incident_todo": false,