datadog_api_client 2.58.0 → 2.59.1

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

@@ -0,0 +1,471 @@
+=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 RumTeamsOwnershipAPI
+    attr_accessor :api_client
+
+    def initialize(api_client = DatadogAPIClient::APIClient.default)
+      @api_client = api_client
+    end
+
+    # Create a teams ownership mapping.
+    #
+    # @see #create_teams_ownership_mapping_with_http_info
+    def create_teams_ownership_mapping(body, opts = {})
+      data, _status_code, _headers = create_teams_ownership_mapping_with_http_info(body, opts)
+      data
+    end
+
+    # Create a teams ownership mapping.
+    #
+    # Create a teams ownership mapping for your organization.
+    # Returns the teams ownership mapping object from the request body when the request is successful.
+    #
+    # @param body [TeamsOwnershipMappingCreateRequest] The definition of the teams ownership mapping to create.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(TeamsOwnershipMappingResponse, Integer, Hash)>] TeamsOwnershipMappingResponse data, response status code and response headers
+    def create_teams_ownership_mapping_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.create_teams_ownership_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_teams_ownership_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_teams_ownership_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.create_teams_ownership_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 RumTeamsOwnershipAPI.create_teams_ownership_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/mappings'
+
+      # 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] || 'TeamsOwnershipMappingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :create_teams_ownership_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: RumTeamsOwnershipAPI#create_teams_ownership_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Bulk create and remove teams ownership mappings.
+    #
+    # @see #create_teams_ownership_mappings_batch_with_http_info
+    def create_teams_ownership_mappings_batch(body, opts = {})
+      data, _status_code, _headers = create_teams_ownership_mappings_batch_with_http_info(body, opts)
+      data
+    end
+
+    # Bulk create and remove teams ownership mappings.
+    #
+    # Add and remove teams ownership mappings for your organization in a single atomic request, following
+    # the JSON:API [atomic operations extension](https://jsonapi.org/ext/atomic/).
+    # Operations are applied together: if any operation is invalid, none of the operations are applied.
+    # Add operations are processed before remove operations, so results may not appear in the same
+    # order as the request.
+    #
+    # @param body [TeamsOwnershipMappingBatchRequest] The list of add and remove operations to apply atomically.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(TeamsOwnershipMappingBatchResponse, Integer, Hash)>] TeamsOwnershipMappingBatchResponse data, response status code and response headers
+    def create_teams_ownership_mappings_batch_with_http_info(body, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.create_teams_ownership_mappings_batch".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_teams_ownership_mappings_batch")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_teams_ownership_mappings_batch"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.create_teams_ownership_mappings_batch ...'
+      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 RumTeamsOwnershipAPI.create_teams_ownership_mappings_batch"
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/mappings/operations'
+
+      # 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] || 'TeamsOwnershipMappingBatchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :create_teams_ownership_mappings_batch,
+        :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: RumTeamsOwnershipAPI#create_teams_ownership_mappings_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a teams ownership mapping.
+    #
+    # @see #delete_teams_ownership_mapping_with_http_info
+    def delete_teams_ownership_mapping(id, opts = {})
+      delete_teams_ownership_mapping_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a teams ownership mapping.
+    #
+    # Delete a specific teams ownership mapping from your organization.
+    #
+    # @param id [String] The ID of the teams ownership mapping.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_teams_ownership_mapping_with_http_info(id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.delete_teams_ownership_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_teams_ownership_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_teams_ownership_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.delete_teams_ownership_mapping ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RumTeamsOwnershipAPI.delete_teams_ownership_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/mappings/{id}'.sub('{id}', CGI.escape(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_teams_ownership_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: RumTeamsOwnershipAPI#delete_teams_ownership_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a teams ownership mapping.
+    #
+    # @see #get_teams_ownership_mapping_with_http_info
+    def get_teams_ownership_mapping(id, opts = {})
+      data, _status_code, _headers = get_teams_ownership_mapping_with_http_info(id, opts)
+      data
+    end
+
+    # Get a teams ownership mapping.
+    #
+    # Get a specific teams ownership mapping from your organization.
+    #
+    # @param id [String] The ID of the teams ownership mapping.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(TeamsOwnershipMappingResponse, Integer, Hash)>] TeamsOwnershipMappingResponse data, response status code and response headers
+    def get_teams_ownership_mapping_with_http_info(id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_teams_ownership_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_teams_ownership_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_teams_ownership_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.get_teams_ownership_mapping ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling RumTeamsOwnershipAPI.get_teams_ownership_mapping"
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/mappings/{id}'.sub('{id}', CGI.escape(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] || 'TeamsOwnershipMappingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :get_teams_ownership_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: RumTeamsOwnershipAPI#get_teams_ownership_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams ownership mappings.
+    #
+    # @see #list_teams_ownership_mappings_with_http_info
+    def list_teams_ownership_mappings(opts = {})
+      data, _status_code, _headers = list_teams_ownership_mappings_with_http_info(opts)
+      data
+    end
+
+    # List teams ownership mappings.
+    #
+    # Get the list of teams ownership mappings for your organization, optionally filtered.
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [Array<String>] :filter_view_name Filter mappings by RUM view name.
+    # @option opts [Array<String>] :filter_team_handle Filter mappings by owning team handle.
+    # @option opts [Array<UUID>] :filter_application_id Filter mappings by RUM application ID. Each value must be a valid UUID.
+    # @option opts [Array<String>] :filter_service Filter mappings by RUM application service name.
+    # @return [Array<(TeamsOwnershipMappingsResponse, Integer, Hash)>] TeamsOwnershipMappingsResponse data, response status code and response headers
+    def list_teams_ownership_mappings_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_teams_ownership_mappings".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_teams_ownership_mappings")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_teams_ownership_mappings"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.list_teams_ownership_mappings ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/mappings'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[view_name]'] = @api_client.build_collection_param(opts[:'filter_view_name'], :multi) if !opts[:'filter_view_name'].nil?
+      query_params[:'filter[team_handle]'] = @api_client.build_collection_param(opts[:'filter_team_handle'], :multi) if !opts[:'filter_team_handle'].nil?
+      query_params[:'filter[application_id]'] = @api_client.build_collection_param(opts[:'filter_application_id'], :multi) if !opts[:'filter_application_id'].nil?
+      query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].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] || 'TeamsOwnershipMappingsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_teams_ownership_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"
+      )
+      new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER
+
+      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: RumTeamsOwnershipAPI#list_teams_ownership_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List teams ownership rules.
+    #
+    # @see #list_teams_ownership_rules_with_http_info
+    def list_teams_ownership_rules(opts = {})
+      data, _status_code, _headers = list_teams_ownership_rules_with_http_info(opts)
+      data
+    end
+
+    # List teams ownership rules.
+    #
+    # Get the list of teams ownership rules for your organization, optionally filtered.
+    # Rules group the underlying mappings by `view_name`, `application_id`, `service`, and `match_type`,
+    # collapsing every team that owns the same view into a single entry.
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [Array<String>] :filter_view_name Filter mappings by RUM view name.
+    # @option opts [Array<String>] :filter_team_handle Filter mappings by owning team handle.
+    # @option opts [Array<UUID>] :filter_application_id Filter mappings by RUM application ID. Each value must be a valid UUID.
+    # @option opts [Array<String>] :filter_service Filter mappings by RUM application service name.
+    # @return [Array<(TeamsOwnershipRulesResponse, Integer, Hash)>] TeamsOwnershipRulesResponse data, response status code and response headers
+    def list_teams_ownership_rules_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_teams_ownership_rules".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_teams_ownership_rules")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_teams_ownership_rules"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RumTeamsOwnershipAPI.list_teams_ownership_rules ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/rum/config/teams-ownership/rules'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[view_name]'] = @api_client.build_collection_param(opts[:'filter_view_name'], :multi) if !opts[:'filter_view_name'].nil?
+      query_params[:'filter[team_handle]'] = @api_client.build_collection_param(opts[:'filter_team_handle'], :multi) if !opts[:'filter_team_handle'].nil?
+      query_params[:'filter[application_id]'] = @api_client.build_collection_param(opts[:'filter_application_id'], :multi) if !opts[:'filter_application_id'].nil?
+      query_params[:'filter[service]'] = @api_client.build_collection_param(opts[:'filter_service'], :multi) if !opts[:'filter_service'].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] || 'TeamsOwnershipRulesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_teams_ownership_rules,
+        :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"
+      )
+      new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER
+
+      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: RumTeamsOwnershipAPI#list_teams_ownership_rules\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/scorecards_api.rb

@@ -515,7 +515,7 @@ module DatadogAPIClient::V2
     # Fetches all rule outcomes.
     #
     # @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_size Number of items to return per page. The maximum allowed value is 100.
     # @option opts [Integer] :page_offset Specific offset to use as the beginning of the returned page.
     # @option opts [String] :include Include related rule details in the response.
     # @option opts [String] :fields_outcome Return only specified values in the outcome attributes.
@@ -616,7 +616,7 @@ module DatadogAPIClient::V2
     # Fetch all rules.
     #
     # @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_size Number of items to return per page. The maximum allowed value is 100.
     # @option opts [Integer] :page_offset Specific offset to use as the beginning of the returned page.
     # @option opts [String] :include Include related scorecard details in the response.
     # @option opts [String] :filter_rule_id Filter the rules on a rule ID.