datadog_api_client 2.17.0 → 2.18.0

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

@@ -23,6 +23,72 @@ module DatadogAPIClient::V2
       @api_client = api_client
     end
 
+    # Get active billing dimensions for cost attribution.
+    #
+    # @see #get_active_billing_dimensions_with_http_info
+    def get_active_billing_dimensions(opts = {})
+      data, _status_code, _headers = get_active_billing_dimensions_with_http_info(opts)
+      data
+    end
+
+    # Get active billing dimensions for cost attribution.
+    #
+    # Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 17th of the following month.
+    #
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(ActiveBillingDimensionsResponse, Integer, Hash)>] ActiveBillingDimensionsResponse data, response status code and response headers
+    def get_active_billing_dimensions_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_active_billing_dimensions".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_active_billing_dimensions")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_active_billing_dimensions"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageMeteringAPI.get_active_billing_dimensions ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/cost_by_tag/active_billing_dimensions'
+
+      # 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;datetime-format=rfc3339'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ActiveBillingDimensionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_active_billing_dimensions,
+        :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: UsageMeteringAPI#get_active_billing_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get cost across multi-org account.
     #
     # @see #get_cost_by_org_with_http_info
@@ -332,6 +398,181 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Get Monthly Cost Attribution.
+    #
+    # @see #get_monthly_cost_attribution_with_http_info
+    def get_monthly_cost_attribution(start_month, end_month, fields, opts = {})
+      data, _status_code, _headers = get_monthly_cost_attribution_with_http_info(start_month, end_month, fields, opts)
+      data
+    end
+
+    # Get Monthly Cost Attribution.
+    #
+    # Get monthly cost attribution by tag across multi-org and single root-org accounts.
+    # Cost Attribution data for a given month becomes available no later than the 17th of the following month.
+    # This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is
+    # set in the response. If it is, make another request and pass `next_record_id` as a parameter.
+    # Pseudo code example:
+    # ```
+    # response := GetMonthlyCostAttribution(start_month, end_month)
+    # cursor := response.metadata.pagination.next_record_id
+    # WHILE cursor != null BEGIN
+    #   sleep(5 seconds)  # Avoid running into rate limit
+    #   response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)
+    #   cursor := response.metadata.pagination.next_record_id
+    # END
+    # ```
+    #
+    # @param start_month [Time] Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month.
+    # @param end_month [Time] Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month.
+    # @param fields [String] Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) and the proportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). Use `*` to retrieve all fields. Example: `infra_host_on_demand_cost,infra_host_percentage_in_account` To obtain the complete list of active billing dimensions that can be used to replace `<billing_dimension>` in the field names, make a request to the [Get active billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution).
+    # @param opts [Hash] the optional parameters
+    # @option opts [SortDirection] :sort_direction The direction to sort by: `[desc, asc]`.
+    # @option opts [String] :sort_name The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`.
+    # @option opts [String] :tag_breakdown_keys Comma separated list of tag keys used to group cost. If no value is provided the cost will not be broken down by tags. To see which tags are available, look for the value of `tag_config_source` in the API response.
+    # @option opts [String] :next_record_id List following results with a next_record_id provided in the previous query.
+    # @option opts [Boolean] :include_descendants Include child org cost in the response. Defaults to `true`.
+    # @return [Array<(MonthlyCostAttributionResponse, Integer, Hash)>] MonthlyCostAttributionResponse data, response status code and response headers
+    def get_monthly_cost_attribution_with_http_info(start_month, end_month, fields, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_monthly_cost_attribution".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_monthly_cost_attribution")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_monthly_cost_attribution"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageMeteringAPI.get_monthly_cost_attribution ...'
+      end
+      # verify the required parameter 'start_month' is set
+      if @api_client.config.client_side_validation && start_month.nil?
+        fail ArgumentError, "Missing the required parameter 'start_month' when calling UsageMeteringAPI.get_monthly_cost_attribution"
+      end
+      # verify the required parameter 'end_month' is set
+      if @api_client.config.client_side_validation && end_month.nil?
+        fail ArgumentError, "Missing the required parameter 'end_month' when calling UsageMeteringAPI.get_monthly_cost_attribution"
+      end
+      # verify the required parameter 'fields' is set
+      if @api_client.config.client_side_validation && fields.nil?
+        fail ArgumentError, "Missing the required parameter 'fields' when calling UsageMeteringAPI.get_monthly_cost_attribution"
+      end
+      allowable_values = ['desc', 'asc']
+      if @api_client.config.client_side_validation && opts[:'sort_direction'] && !allowable_values.include?(opts[:'sort_direction'])
+        fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v2/cost_by_tag/monthly_cost_attribution'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_month'] = start_month
+      query_params[:'end_month'] = end_month
+      query_params[:'fields'] = fields
+      query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
+      query_params[:'sort_name'] = opts[:'sort_name'] if !opts[:'sort_name'].nil?
+      query_params[:'tag_breakdown_keys'] = opts[:'tag_breakdown_keys'] if !opts[:'tag_breakdown_keys'].nil?
+      query_params[:'next_record_id'] = opts[:'next_record_id'] if !opts[:'next_record_id'].nil?
+      query_params[:'include_descendants'] = opts[:'include_descendants'] if !opts[:'include_descendants'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;datetime-format=rfc3339'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MonthlyCostAttributionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_monthly_cost_attribution,
+        :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: UsageMeteringAPI#get_monthly_cost_attribution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get projected cost across your account.
+    #
+    # @see #get_projected_cost_with_http_info
+    def get_projected_cost(opts = {})
+      data, _status_code, _headers = get_projected_cost_with_http_info(opts)
+      data
+    end
+
+    # Get projected cost across your account.
+    #
+    # Get projected cost across multi-org and single root-org accounts.
+    # Projected cost data is only available for the current month and becomes available around the 12th of the month.
+    # This endpoint requires the usage_read authorization scope.
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [String] :view String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`.
+    # @return [Array<(ProjectedCostResponse, Integer, Hash)>] ProjectedCostResponse data, response status code and response headers
+    def get_projected_cost_with_http_info(opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageMeteringAPI.get_projected_cost ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/usage/projected_cost'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'view'] = opts[:'view'] if !opts[:'view'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;datetime-format=rfc3339'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProjectedCostResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_projected_cost,
+        :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: UsageMeteringAPI#get_projected_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get hourly usage for application security.
     #
     # @see #get_usage_application_security_monitoring_with_http_info

data/lib/datadog_api_client/v2/models/active_billing_dimensions_attributes.rb

@@ -0,0 +1,92 @@
+=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 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # List of active billing dimensions.
+  class ActiveBillingDimensionsAttributes
+    include BaseGenericModel
+
+    # Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.
+    attr_accessor :month
+
+    # List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.
+    attr_accessor :values
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'month' => :'month',
+        :'values' => :'values'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'month' => :'Time',
+        :'values' => :'Array<String>'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ActiveBillingDimensionsAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::ActiveBillingDimensionsAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'month')
+        self.month = attributes[:'month']
+      end
+
+      if attributes.key?(:'values')
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          month == o.month &&
+          values == o.values
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [month, values].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/active_billing_dimensions_body.rb

@@ -0,0 +1,100 @@
+=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 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Active billing dimensions data.
+  class ActiveBillingDimensionsBody
+    include BaseGenericModel
+
+    # List of active billing dimensions.
+    attr_accessor :attributes
+
+    # Unique ID of the response.
+    attr_accessor :id
+
+    # Type of active billing dimensions data.
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'id' => :'id',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'attributes' => :'ActiveBillingDimensionsAttributes',
+        :'id' => :'String',
+        :'type' => :'ActiveBillingDimensionsType'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ActiveBillingDimensionsBody` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::ActiveBillingDimensionsBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          attributes == o.attributes &&
+          id == o.id &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [attributes, id, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/active_billing_dimensions_response.rb

@@ -0,0 +1,80 @@
+=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 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Active billing dimensions response.
+  class ActiveBillingDimensionsResponse
+    include BaseGenericModel
+
+    # Active billing dimensions data.
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'ActiveBillingDimensionsBody'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::ActiveBillingDimensionsResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::ActiveBillingDimensionsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/active_billing_dimensions_type.rb

@@ -0,0 +1,26 @@
+=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 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Type of active billing dimensions data.
+  class ActiveBillingDimensionsType
+    include BaseEnumModel
+
+    BILLING_DIMENSIONS = "billing_dimensions".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/api_keys_response.rb

@@ -27,12 +27,16 @@ module DatadogAPIClient::V2
     # Array of objects related to the API key.
     attr_accessor :included
 
+    # Additional information related to api keys response.
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     # @!visibility private
     def self.attribute_map
       {
         :'data' => :'data',
-        :'included' => :'included'
+        :'included' => :'included',
+        :'meta' => :'meta'
       }
     end
 
@@ -41,7 +45,8 @@ module DatadogAPIClient::V2
     def self.openapi_types
       {
         :'data' => :'Array<PartialAPIKey>',
-        :'included' => :'Array<APIKeyResponseIncludedItem>'
+        :'included' => :'Array<APIKeyResponseIncludedItem>',
+        :'meta' => :'APIKeysResponseMeta'
       }
     end
 
@@ -72,6 +77,10 @@ module DatadogAPIClient::V2
           self.included = value
         end
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Checks equality by comparing each attribute.
@@ -81,14 +90,15 @@ module DatadogAPIClient::V2
       return true if self.equal?(o)
       self.class == o.class &&
           data == o.data &&
-          included == o.included
+          included == o.included &&
+          meta == o.meta
     end
 
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [data, included].hash
+      [data, included, meta].hash
     end
   end
 end