Regenerate client from commit a45a8aa9 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-09-10 15:39:59.557937",
-            "spec_repo_commit": "80dc4248"
+            "regenerated": "2024-09-10 17:48:03.026954",
+            "spec_repo_commit": "a45a8aa9"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-09-10 15:39:59.575646",
-            "spec_repo_commit": "80dc4248"
+            "regenerated": "2024-09-10 17:48:03.044838",
+            "spec_repo_commit": "a45a8aa9"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -2117,6 +2117,73 @@ components:
       - storage_account
       - storage_container
       type: object
+    BillingDimensionsMappingBody:
+      description: Billing dimensions mapping data.
+      items:
+        $ref: '#/components/schemas/BillingDimensionsMappingBodyItem'
+      type: array
+    BillingDimensionsMappingBodyItem:
+      description: The definition of `BillingDimensionsMappingBodyItem` object.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributes'
+        id:
+          description: ID of the billing dimension.
+          type: string
+        type:
+          $ref: '#/components/schemas/ActiveBillingDimensionsType'
+      type: object
+    BillingDimensionsMappingBodyItemAttributes:
+      description: Mapping of billing dimensions to endpoint keys.
+      properties:
+        endpoints:
+          description: List of supported endpoints with their keys mapped to the billing_dimension.
+          items:
+            $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems'
+          type: array
+        in_app_label:
+          description: Label used for the billing dimension in the Plan & Usage charts.
+          example: APM Hosts
+          type: string
+        timestamp:
+          description: 'Month in ISO-8601 format, UTC, precise to second: `[YYYY-MM-DDThh:mm:ss]`.'
+          format: date-time
+          type: string
+      type: object
+    BillingDimensionsMappingBodyItemAttributesEndpointsItems:
+      description: An endpoint's keys mapped to the billing_dimension.
+      properties:
+        id:
+          description: The URL for the endpoint.
+          example: api/v1/usage/billable-summary
+          type: string
+        keys:
+          description: The billing dimension.
+          example:
+          - apm_host_top99p
+          - apm_host_sum
+          items:
+            example: apm_host_top99p
+            type: string
+          type: array
+        status:
+          $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus'
+      type: object
+    BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus:
+      description: Denotes whether or not mapping keys were available for this endpoint.
+      enum:
+      - OK
+      - NOT_FOUND
+      type: string
+      x-enum-varnames:
+      - OK
+      - NOT_FOUND
+    BillingDimensionsMappingResponse:
+      description: Billing dimensions mapping response.
+      properties:
+        data:
+          $ref: '#/components/schemas/BillingDimensionsMappingBody'
+      type: object
     BulkMuteFindingsRequest:
       description: The new bulk mute finding request.
       properties:
@@ -38362,6 +38429,68 @@ paths:
       summary: Get hourly usage for application security
       tags:
       - Usage Metering
+  /api/v2/usage/billing_dimension_mapping:
+    get:
+      description: 'Get a mapping of billing dimensions to the corresponding keys
+        for the supported usage metering public API endpoints.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
+      operationId: GetBillingDimensionMapping
+      parameters:
+      - description: Datetime in ISO-8601 format, UTC, for mappings beginning this
+          month. Defaults to the current month.
+        in: query
+        name: filter[month]
+        required: false
+        schema:
+          format: date-time
+          type: string
+      - description: String to specify whether to retrieve active billing dimension
+          mappings or all available mappings. Available views are `active` and `all`.
+          Defaults to `active`.
+        in: query
+        name: filter[view]
+        required: false
+        schema:
+          default: active
+          type: string
+      responses:
+        '200':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/BillingDimensionsMappingResponse'
+          description: OK
+        '400':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Bad Request
+        '403':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden - User is not authorized
+        '429':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Too many requests
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - usage_read
+      summary: Get billing dimensions mapping for usage endpoints
+      tags:
+      - Usage Metering
+      x-unstable: '**Note**: This endpoint is in public beta.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/usage/cost_by_org:
     get:
       deprecated: true

examples/v2/usage-metering/GetBillingDimensionMapping.rb

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

features/scenarios_model_mapping.rb

@@ -1116,6 +1116,10 @@
             "start_hr" => "Time",
             "end_hr" => "Time",
     },
+    "v2.GetBillingDimensionMapping" => {
+            "filter_month" => "Time",
+            "filter_view" => "String",
+    },
     "v2.GetCostByOrg" => {
             "start_month" => "Time",
             "end_month" => "Time",

features/v2/undo.json

@@ -2365,6 +2365,12 @@
       "type": "safe"
     }
   },
+  "GetBillingDimensionMapping": {
+    "tag": "Usage Metering",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "GetCostByOrg": {
     "tag": "Usage Metering",
     "undo": {

features/v2/usage_metering.feature

@@ -48,6 +48,20 @@ Feature: Usage Metering
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/revenue-query
+  Scenario: Get billing dimensions mapping for usage endpoints returns "Bad Request" response
+    Given operation "GetBillingDimensionMapping" enabled
+    And new "GetBillingDimensionMapping" request
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/revenue-query
+  Scenario: Get billing dimensions mapping for usage endpoints returns "OK" response
+    Given operation "GetBillingDimensionMapping" enabled
+    And new "GetBillingDimensionMapping" request
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/revenue-query
   Scenario: Get cost across multi-org account returns "Bad Request" response
     Given new "GetCostByOrg" request

lib/datadog_api_client/configuration.rb

@@ -195,6 +195,7 @@ def initialize
             "v2.list_apis": false,
             "v2.update_open_api": false,
             "v2.get_active_billing_dimensions": false,
+            "v2.get_billing_dimension_mapping": false,
             "v2.get_monthly_cost_attribution": false,
             "v2.create_dora_deployment": false,
             "v2.create_dora_incident": false,

lib/datadog_api_client/inflector.rb

@@ -972,6 +972,11 @@ def overrides
           "v2.azure_uc_config_post_request_type" => "AzureUCConfigPostRequestType",
           "v2.azure_uc_configs_response" => "AzureUCConfigsResponse",
           "v2.bill_config" => "BillConfig",
+          "v2.billing_dimensions_mapping_body_item" => "BillingDimensionsMappingBodyItem",
+          "v2.billing_dimensions_mapping_body_item_attributes" => "BillingDimensionsMappingBodyItemAttributes",
+          "v2.billing_dimensions_mapping_body_item_attributes_endpoints_items" => "BillingDimensionsMappingBodyItemAttributesEndpointsItems",
+          "v2.billing_dimensions_mapping_body_item_attributes_endpoints_items_status" => "BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus",
+          "v2.billing_dimensions_mapping_response" => "BillingDimensionsMappingResponse",
           "v2.bulk_mute_findings_request" => "BulkMuteFindingsRequest",
           "v2.bulk_mute_findings_request_attributes" => "BulkMuteFindingsRequestAttributes",
           "v2.bulk_mute_findings_request_data" => "BulkMuteFindingsRequestData",

lib/datadog_api_client/v2/api/usage_metering_api.rb

@@ -89,6 +89,78 @@ def get_active_billing_dimensions_with_http_info(opts = {})
       return data, status_code, headers
     end
 
+    # Get billing dimensions mapping for usage endpoints.
+    #
+    # @see #get_billing_dimension_mapping_with_http_info
+    def get_billing_dimension_mapping(opts = {})
+      data, _status_code, _headers = get_billing_dimension_mapping_with_http_info(opts)
+      data
+    end
+
+    # Get billing dimensions mapping for usage endpoints.
+    #
+    # Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints.
+    #
+    # This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).
+    #
+    # @param opts [Hash] the optional parameters
+    # @option opts [Time] :filter_month Datetime in ISO-8601 format, UTC, for mappings beginning this month. Defaults to the current month.
+    # @option opts [String] :filter_view String to specify whether to retrieve active billing dimension mappings or all available mappings. Available views are `active` and `all`. Defaults to `active`.
+    # @return [Array<(BillingDimensionsMappingResponse, Integer, Hash)>] BillingDimensionsMappingResponse data, response status code and response headers
+    def get_billing_dimension_mapping_with_http_info(opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_billing_dimension_mapping".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_billing_dimension_mapping")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_billing_dimension_mapping"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageMeteringAPI.get_billing_dimension_mapping ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/usage/billing_dimension_mapping'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[month]'] = opts[:'filter_month'] if !opts[:'filter_month'].nil?
+      query_params[:'filter[view]'] = opts[:'filter_view'] if !opts[:'filter_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] || 'BillingDimensionsMappingResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_billing_dimension_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: UsageMeteringAPI#get_billing_dimension_mapping\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