datadog_api_client 2.46.0 → 2.48.0

data/lib/datadog_api_client/v2/api/product_analytics_api.rb

@@ -0,0 +1,121 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'cgi'
+
+module DatadogAPIClient::V2
+  class ProductAnalyticsAPI
+    attr_accessor :api_client
+
+    def initialize(api_client = DatadogAPIClient::APIClient.default)
+      @api_client = api_client
+    end
+
+    # Send server-side events.
+    #
+    # @see #submit_product_analytics_event_with_http_info
+    def submit_product_analytics_event(body, opts = {})
+      data, _status_code, _headers = submit_product_analytics_event_with_http_info(body, opts)
+      data
+    end
+
+    # Send server-side events.
+    #
+    # Send server-side events to Product Analytics. Server-side events are retained for 15 months.
+    #
+    # Server-Side events in Product Analytics are helpful for tracking events that occur on the server,
+    # as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs.
+    # This allows for a more comprehensive view of the user journey by including actions that happen on the server.
+    # Typical examples could be `checkout.completed` or `payment.processed`.
+    #
+    # Ingested server-side events are integrated into Product Analytics to allow users to select and filter
+    # these events in the event picker, similar to how views or actions are handled.
+    #
+    # **Requirements:**
+    # - At least one of `usr`, `account`, or `session` must be provided with a valid ID.
+    # - The `application.id` must reference a Product Analytics-enabled application.
+    #
+    # **Custom Attributes:**
+    # Any additional fields in the payload are flattened and searchable as facets.
+    # For example, a payload with `{"customer": {"tier": "premium"}}` is searchable with
+    # the syntax `@customer.tier:premium` in Datadog.
+    #
+    # The status codes answered by the HTTP API are:
+    # - 202: Accepted: The request has been accepted for processing
+    # - 400: Bad request (likely an issue in the payload formatting)
+    # - 401: Unauthorized (likely a missing API Key)
+    # - 403: Permission issue (likely using an invalid API Key)
+    # - 408: Request Timeout, request should be retried after some time
+    # - 413: Payload too large (batch is above 5MB uncompressed)
+    # - 429: Too Many Requests, request should be retried after some time
+    # - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time
+    # - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time
+    #
+    # @param body [ProductAnalyticsServerSideEventItem] Server-side event to send (JSON format).
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def submit_product_analytics_event_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductAnalyticsAPI.submit_product_analytics_event ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling ProductAnalyticsAPI.submit_product_analytics_event"
+      end
+      # resource path
+      local_var_path = '/api/v2/prodlytics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :submit_product_analytics_event,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProductAnalyticsAPI#submit_product_analytics_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/datadog_api_client/v2/api/security_monitoring_api.rb

@@ -33,9 +33,10 @@ module DatadogAPIClient::V2
 
     # Attach security findings to a case.
     #
-    # 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.
+    # 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 case_id [String] The unique identifier of the case to attach security findings to
+    # @param case_id [String] Unique identifier of the case to attach security findings to
     # @param body [AttachCaseRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(FindingCaseResponse, Integer, Hash)>] FindingCaseResponse data, response status code and response headers
@@ -105,12 +106,19 @@ module DatadogAPIClient::V2
 
     # Attach security findings to a Jira issue.
     #
-    # 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.
+    # 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. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). 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 body [AttachJiraIssueRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(FindingCaseResponse, Integer, Hash)>] FindingCaseResponse data, response status code and response headers
     def attach_jira_issue_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.attach_jira_issue".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.attach_jira_issue")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.attach_jira_issue"))
+      end
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.attach_jira_issue ...'
@@ -460,7 +468,8 @@ module DatadogAPIClient::V2
 
     # Create cases for security findings.
     #
-    # 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.
+    # 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 body [CreateCaseRequestArray] 
     # @param opts [Hash] the optional parameters
@@ -594,12 +603,19 @@ module DatadogAPIClient::V2
 
     # Create Jira issues for security findings.
     #
-    # 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.
+    # 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. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-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 body [CreateJiraIssueRequestArray] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(FindingCaseResponseArray, Integer, Hash)>] FindingCaseResponseArray data, response status code and response headers
     def create_jira_issues_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.create_jira_issues".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_jira_issues")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_jira_issues"))
+      end
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.create_jira_issues ...'
@@ -1465,7 +1481,8 @@ module DatadogAPIClient::V2
 
     # Detach security findings from their case.
     #
-    # 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.
+    # 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 body [DetachCaseRequest] 
     # @param opts [Hash] the optional parameters
@@ -2115,7 +2132,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Returns list of Secrets rules.
+    # Returns a list of Secrets rules.
     #
     # @see #get_secrets_rules_with_http_info
     def get_secrets_rules(opts = {})
@@ -2123,9 +2140,9 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Returns list of Secrets rules.
+    # Returns a list of Secrets rules.
     #
-    # Returns list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID
+    # Returns a list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID.
     #
     # @param opts [Hash] the optional parameters
     # @return [Array<(SecretRuleArray, Integer, Hash)>] SecretRuleArray data, response status code and response headers
@@ -2862,6 +2879,75 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Get a suppression's version history.
+    #
+    # @see #get_suppression_version_history_with_http_info
+    def get_suppression_version_history(suppression_id, opts = {})
+      data, _status_code, _headers = get_suppression_version_history_with_http_info(suppression_id, opts)
+      data
+    end
+
+    # Get a suppression's version history.
+    #
+    # Get a suppression's version history.
+    #
+    # @param suppression_id [String] The ID of the suppression rule
+    # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :page_size Size for a given page. The maximum allowed value is 100.
+    # @option opts [Integer] :page_number Specific page number to return.
+    # @return [Array<(GetSuppressionVersionHistoryResponse, Integer, Hash)>] GetSuppressionVersionHistoryResponse data, response status code and response headers
+    def get_suppression_version_history_with_http_info(suppression_id, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_suppression_version_history ...'
+      end
+      # verify the required parameter 'suppression_id' is set
+      if @api_client.config.client_side_validation && suppression_id.nil?
+        fail ArgumentError, "Missing the required parameter 'suppression_id' when calling SecurityMonitoringAPI.get_suppression_version_history"
+      end
+      # resource path
+      local_var_path = '/api/v2/security_monitoring/configuration/suppressions/{suppression_id}/version_history'.sub('{suppression_id}', CGI.escape(suppression_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSuppressionVersionHistoryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_suppression_version_history,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_suppression_version_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a job's details.
     #
     # @see #get_threat_hunting_job_with_http_info
@@ -4117,6 +4203,7 @@ module DatadogAPIClient::V2
     # @option opts [Boolean] :filter_fix_available Filter by fix availability.
     # @option opts [String] :filter_repo_digests Filter by vulnerability `repo_digest` (when the vulnerability is related to `Image` asset).
     # @option opts [String] :filter_origin Filter by origin.
+    # @option opts [Boolean] :filter_running_kernel Filter for whether the vulnerability affects a running kernel (for vulnerabilities related to a `Host` asset).
     # @option opts [String] :filter_asset_name Filter by asset name. This field supports the usage of wildcards (*).
     # @option opts [AssetType] :filter_asset_type Filter by asset type.
     # @option opts [String] :filter_asset_version_first Filter by the first version of the asset this vulnerability has been detected on.
@@ -4175,7 +4262,7 @@ module DatadogAPIClient::V2
       if @api_client.config.client_side_validation && opts[:'filter_status'] && !allowable_values.include?(opts[:'filter_status'])
         fail ArgumentError, "invalid value for \"filter_status\", must be one of #{allowable_values}"
       end
-      allowable_values = ['IAST', 'SCA', 'Infra']
+      allowable_values = ['IAST', 'SCA', 'Infra', 'SAST']
       if @api_client.config.client_side_validation && opts[:'filter_tool'] && !allowable_values.include?(opts[:'filter_tool'])
         fail ArgumentError, "invalid value for \"filter_tool\", must be one of #{allowable_values}"
       end
@@ -4189,7 +4276,7 @@ module DatadogAPIClient::V2
       if @api_client.config.client_side_validation && opts[:'filter_risks_epss_severity'] && !allowable_values.include?(opts[:'filter_risks_epss_severity'])
         fail ArgumentError, "invalid value for \"filter_risks_epss_severity\", must be one of #{allowable_values}"
       end
-      allowable_values = ['PyPI', 'Maven', 'NuGet', 'Npm', 'RubyGems', 'Go', 'Packagist', 'Ddeb', 'Rpm', 'Apk', 'Windows']
+      allowable_values = ['PyPI', 'Maven', 'NuGet', 'Npm', 'RubyGems', 'Go', 'Packagist', 'Deb', 'Rpm', 'Apk', 'Windows', 'Generic', 'MacOs', 'Oci', 'BottleRocket', 'None']
       if @api_client.config.client_side_validation && opts[:'filter_ecosystem'] && !allowable_values.include?(opts[:'filter_ecosystem'])
         fail ArgumentError, "invalid value for \"filter_ecosystem\", must be one of #{allowable_values}"
       end
@@ -4229,6 +4316,7 @@ module DatadogAPIClient::V2
       query_params[:'filter[fix_available]'] = opts[:'filter_fix_available'] if !opts[:'filter_fix_available'].nil?
       query_params[:'filter[repo_digests]'] = opts[:'filter_repo_digests'] if !opts[:'filter_repo_digests'].nil?
       query_params[:'filter[origin]'] = opts[:'filter_origin'] if !opts[:'filter_origin'].nil?
+      query_params[:'filter[running_kernel]'] = opts[:'filter_running_kernel'] if !opts[:'filter_running_kernel'].nil?
       query_params[:'filter[asset.name]'] = opts[:'filter_asset_name'] if !opts[:'filter_asset_name'].nil?
       query_params[:'filter[asset.type]'] = opts[:'filter_asset_type'] if !opts[:'filter_asset_type'].nil?
       query_params[:'filter[asset.version.first]'] = opts[:'filter_asset_version_first'] if !opts[:'filter_asset_version_first'].nil?

data/lib/datadog_api_client/v2/api/software_catalog_api.rb

@@ -176,6 +176,7 @@ module DatadogAPIClient::V2
     # @option opts [RelationType] :filter_relation_type Filter entities by relation type.
     # @option opts [String] :filter_exclude_snapshot Filter entities by excluding snapshotted entities.
     # @option opts [IncludeType] :include Include relationship data.
+    # @option opts [Boolean] :include_discovered If true, includes discovered services from APM and USM that do not have entity definitions.
     # @return [Array<(ListEntityCatalogResponse, Integer, Hash)>] ListEntityCatalogResponse data, response status code and response headers
     def list_catalog_entity_with_http_info(opts = {})
 
@@ -205,6 +206,7 @@ module DatadogAPIClient::V2
       query_params[:'filter[relation][type]'] = opts[:'filter_relation_type'] if !opts[:'filter_relation_type'].nil?
       query_params[:'filter[exclude_snapshot]'] = opts[:'filter_exclude_snapshot'] if !opts[:'filter_exclude_snapshot'].nil?
       query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
+      query_params[:'includeDiscovered'] = opts[:'include_discovered'] if !opts[:'include_discovered'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -370,6 +372,7 @@ module DatadogAPIClient::V2
     # @option opts [String] :filter_from_ref Filter relations by the reference of the first entity in the relation.
     # @option opts [String] :filter_to_ref Filter relations by the reference of the second entity in the relation.
     # @option opts [RelationIncludeType] :include Include relationship data.
+    # @option opts [Boolean] :include_discovered If true, includes relationships discovered by APM and USM.
     # @return [Array<(ListRelationCatalogResponse, Integer, Hash)>] ListRelationCatalogResponse data, response status code and response headers
     def list_catalog_relation_with_http_info(opts = {})
 
@@ -395,6 +398,7 @@ module DatadogAPIClient::V2
       query_params[:'filter[from_ref]'] = opts[:'filter_from_ref'] if !opts[:'filter_from_ref'].nil?
       query_params[:'filter[to_ref]'] = opts[:'filter_to_ref'] if !opts[:'filter_to_ref'].nil?
       query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
+      query_params[:'includeDiscovered'] = opts[:'include_discovered'] if !opts[:'include_discovered'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/datadog_api_client/v2/api/synthetics_api.rb

@@ -83,6 +83,85 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Patch a global variable.
+    #
+    # @see #patch_global_variable_with_http_info
+    def patch_global_variable(variable_id, body, opts = {})
+      data, _status_code, _headers = patch_global_variable_with_http_info(variable_id, body, opts)
+      data
+    end
+
+    # Patch a global variable.
+    #
+    # Patch a global variable using JSON Patch (RFC 6902).
+    # This endpoint allows partial updates to a global variable by specifying only the fields to modify.
+    #
+    # Common operations include:
+    # - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}`
+    # - Update nested values: `{"op": "replace", "path": "/value/value", "value": "new_value"}`
+    # - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}`
+    # - Remove fields: `{"op": "remove", "path": "/description"}`
+    #
+    # @param variable_id [String] The ID of the global variable.
+    # @param body [GlobalVariableJsonPatchRequest] JSON Patch document with operations to apply.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(GlobalVariableResponse, Integer, Hash)>] GlobalVariableResponse data, response status code and response headers
+    def patch_global_variable_with_http_info(variable_id, body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SyntheticsAPI.patch_global_variable ...'
+      end
+      # verify the required parameter 'variable_id' is set
+      if @api_client.config.client_side_validation && variable_id.nil?
+        fail ArgumentError, "Missing the required parameter 'variable_id' when calling SyntheticsAPI.patch_global_variable"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling SyntheticsAPI.patch_global_variable"
+      end
+      # resource path
+      local_var_path = '/api/v2/synthetics/variables/{variable_id}/jsonpatch'.sub('{variable_id}', CGI.escape(variable_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlobalVariableResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :patch_global_variable,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SyntheticsAPI#patch_global_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Save new value for on-demand concurrency cap.
     #
     # @see #set_on_demand_concurrency_cap_with_http_info