datadog_api_client 2.50.0 → 2.51.0

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

@@ -0,0 +1,307 @@
+=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 CloudAuthenticationAPI
+    attr_accessor :api_client
+
+    def initialize(api_client = DatadogAPIClient::APIClient.default)
+      @api_client = api_client
+    end
+
+    # Create an AWS cloud authentication persona mapping.
+    #
+    # @see #create_aws_cloud_auth_persona_mapping_with_http_info
+    def create_aws_cloud_auth_persona_mapping(body, opts = {})
+      data, _status_code, _headers = create_aws_cloud_auth_persona_mapping_with_http_info(body, opts)
+      data
+    end
+
+    # Create an AWS cloud authentication persona mapping.
+    #
+    # Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user.
+    #
+    # @param body [AWSCloudAuthPersonaMappingCreateRequest] 
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(AWSCloudAuthPersonaMappingResponse, Integer, Hash)>] AWSCloudAuthPersonaMappingResponse data, response status code and response headers
+    def create_aws_cloud_auth_persona_mapping_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.create_aws_cloud_auth_persona_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_aws_cloud_auth_persona_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_aws_cloud_auth_persona_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.create_aws_cloud_auth_persona_mapping ...'
+      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 CloudAuthenticationAPI.create_aws_cloud_auth_persona_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/cloud_auth/aws/persona_mapping'
+
+      # 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] || 'AWSCloudAuthPersonaMappingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :create_aws_cloud_auth_persona_mapping,
+        :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: CloudAuthenticationAPI#create_aws_cloud_auth_persona_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an AWS cloud authentication persona mapping.
+    #
+    # @see #delete_aws_cloud_auth_persona_mapping_with_http_info
+    def delete_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
+      delete_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
+      nil
+    end
+
+    # Delete an AWS cloud authentication persona mapping.
+    #
+    # Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user.
+    #
+    # @param persona_mapping_id [String] The ID of the persona mapping
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.delete_aws_cloud_auth_persona_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_aws_cloud_auth_persona_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_aws_cloud_auth_persona_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.delete_aws_cloud_auth_persona_mapping ...'
+      end
+      # verify the required parameter 'persona_mapping_id' is set
+      if @api_client.config.client_side_validation && persona_mapping_id.nil?
+        fail ArgumentError, "Missing the required parameter 'persona_mapping_id' when calling CloudAuthenticationAPI.delete_aws_cloud_auth_persona_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/cloud_auth/aws/persona_mapping/{persona_mapping_id}'.sub('{persona_mapping_id}', CGI.escape(persona_mapping_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :delete_aws_cloud_auth_persona_mapping,
+        :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::Delete, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CloudAuthenticationAPI#delete_aws_cloud_auth_persona_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an AWS cloud authentication persona mapping.
+    #
+    # @see #get_aws_cloud_auth_persona_mapping_with_http_info
+    def get_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
+      data, _status_code, _headers = get_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
+      data
+    end
+
+    # Get an AWS cloud authentication persona mapping.
+    #
+    # Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user.
+    #
+    # @param persona_mapping_id [String] The ID of the persona mapping
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(AWSCloudAuthPersonaMappingResponse, Integer, Hash)>] AWSCloudAuthPersonaMappingResponse data, response status code and response headers
+    def get_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_aws_cloud_auth_persona_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_aws_cloud_auth_persona_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_aws_cloud_auth_persona_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.get_aws_cloud_auth_persona_mapping ...'
+      end
+      # verify the required parameter 'persona_mapping_id' is set
+      if @api_client.config.client_side_validation && persona_mapping_id.nil?
+        fail ArgumentError, "Missing the required parameter 'persona_mapping_id' when calling CloudAuthenticationAPI.get_aws_cloud_auth_persona_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/cloud_auth/aws/persona_mapping/{persona_mapping_id}'.sub('{persona_mapping_id}', CGI.escape(persona_mapping_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AWSCloudAuthPersonaMappingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :get_aws_cloud_auth_persona_mapping,
+        :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: CloudAuthenticationAPI#get_aws_cloud_auth_persona_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List AWS cloud authentication persona mappings.
+    #
+    # @see #list_aws_cloud_auth_persona_mappings_with_http_info
+    def list_aws_cloud_auth_persona_mappings(opts = {})
+      data, _status_code, _headers = list_aws_cloud_auth_persona_mappings_with_http_info(opts)
+      data
+    end
+
+    # List AWS cloud authentication persona mappings.
+    #
+    # List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users.
+    #
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(AWSCloudAuthPersonaMappingsResponse, Integer, Hash)>] AWSCloudAuthPersonaMappingsResponse data, response status code and response headers
+    def list_aws_cloud_auth_persona_mappings_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_aws_cloud_auth_persona_mappings".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_aws_cloud_auth_persona_mappings")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_aws_cloud_auth_persona_mappings"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.list_aws_cloud_auth_persona_mappings ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/cloud_auth/aws/persona_mapping'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AWSCloudAuthPersonaMappingsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_aws_cloud_auth_persona_mappings,
+        :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: CloudAuthenticationAPI#list_aws_cloud_auth_persona_mappings\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/code_coverage_api.rb

@@ -37,8 +37,6 @@ module DatadogAPIClient::V2
     # This endpoint provides overall coverage metrics as well as breakdowns by service
     # and code owner.
     #
-    # **Note**: This endpoint requires the `code_coverage_read` permission.
-    #
     # @param body [BranchCoverageSummaryRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(CoverageSummaryResponse, Integer, Hash)>] CoverageSummaryResponse data, response status code and response headers
@@ -116,8 +114,6 @@ module DatadogAPIClient::V2
     #
     # The commit SHA must be a 40-character hexadecimal string (SHA-1 hash).
     #
-    # **Note**: This endpoint requires the `code_coverage_read` permission.
-    #
     # @param body [CommitCoverageSummaryRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(CoverageSummaryResponse, Integer, Hash)>] CoverageSummaryResponse data, response status code and response headers

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

@@ -39,6 +39,7 @@ module DatadogAPIClient::V2
     # - Deployment Frequency
     # - Change Lead Time
     # - Change Failure Rate
+    # - Failed Deployment Recovery Time
     #
     # @param body [DORADeploymentRequest] 
     # @param opts [Hash] the optional parameters
@@ -95,7 +96,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Send a failure event.
+    # Send an incident event.
     #
     # @see #create_dora_failure_with_http_info
     def create_dora_failure(body, opts = {})
@@ -103,13 +104,11 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Send a failure event.
-    #
-    # Use this API endpoint to provide failure data.
+    # Send an incident event.
     #
-    # This is necessary for:
-    # - Change Failure Rate
-    # - Time to Restore
+    # Use this API endpoint to provide incident data for DORA Metrics.
+    # Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint.
+    # Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.
     #
     # @param body [DORAFailureRequest] 
     # @param opts [Hash] the optional parameters
@@ -166,7 +165,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Send an incident event.
+    # Send an incident event (legacy).
     #
     # @see #create_dora_incident_with_http_info
     def create_dora_incident(body, opts = {})
@@ -174,15 +173,12 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Send an incident event.
+    # Send an incident event (legacy).
     #
     # **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.
     #
-    # Use this API endpoint to provide failure data.
-    #
-    # This is necessary for:
-    # - Change Failure Rate
-    # - Time to Restore
+    # Use this API endpoint to provide incident data.
+    # Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents.
     #
     # @deprecated This API is deprecated.
     #
@@ -307,7 +303,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Delete a failure event.
+    # Delete an incident event.
     #
     # @see #delete_dora_failure_with_http_info
     def delete_dora_failure(failure_id, opts = {})
@@ -315,11 +311,11 @@ module DatadogAPIClient::V2
       nil
     end
 
-    # Delete a failure event.
+    # Delete an incident event.
     #
-    # Use this API endpoint to delete a failure event.
+    # Use this API endpoint to delete an incident event.
     #
-    # @param failure_id [String] The ID of the failure event to delete.
+    # @param failure_id [String] The ID of the incident event to delete.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_dora_failure_with_http_info(failure_id, opts = {})
@@ -437,7 +433,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Get a failure event.
+    # Get an incident event.
     #
     # @see #get_dora_failure_with_http_info
     def get_dora_failure(failure_id, opts = {})
@@ -445,11 +441,11 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Get a failure event.
+    # Get an incident event.
     #
-    # Use this API endpoint to get a failure event.
+    # Use this API endpoint to get an incident event.
     #
-    # @param failure_id [String] The ID of the failure event.
+    # @param failure_id [String] The ID of the incident event.
     # @param opts [Hash] the optional parameters
     # @return [Array<(DORAFailureFetchResponse, Integer, Hash)>] DORAFailureFetchResponse data, response status code and response headers
     def get_dora_failure_with_http_info(failure_id, opts = {})
@@ -569,7 +565,7 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
-    # Get a list of failure events.
+    # Get a list of incident events.
     #
     # @see #list_dora_failures_with_http_info
     def list_dora_failures(body, opts = {})
@@ -577,9 +573,9 @@ module DatadogAPIClient::V2
       data
     end
 
-    # Get a list of failure events.
+    # Get a list of incident events.
     #
-    # Use this API endpoint to get a list of failure events.
+    # Use this API endpoint to get a list of incident events.
     #
     # @param body [DORAListFailuresRequest] 
     # @param opts [Hash] the optional parameters
@@ -646,7 +642,7 @@ module DatadogAPIClient::V2
 
     # Patch a deployment event.
     #
-    # Use this API endpoint to patch a deployment event.
+    # Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.
     #
     # @param deployment_id [String] The ID of the deployment event.
     # @param body [DORADeploymentPatchRequest]